readme

README.adoc

+= Portal Backend
+
+Kontr portal backend 
+
+== Getting Started
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
+
+== Installation
+- Take a look at the installation document `docs/Installation.adoc`
+
+
+== Running the tests
+
+- To run the test you need to run:
+
+[source, bash]
+----
+pipenv run coverage run -m pytest
+----
+
+
+== Deployment
+
+- Take a look at the installation document `docs/Installation.adoc` ->
+Docker and Docker compose section
+
+
+== Contributing
+
+Please read `CONTRIBUTION.adoc` for details on our code of conduct,
+and the process for submitting pull requests to us.
+
+== Authors
+
+* *Barbora Kompisova* - _Initial work_ - https://gitlab.fi.muni.cz/xkompis[xkompis]
+
+
+
+== Acknowledgments
+
+* Hat tip to anyone who's code was used
+* Inspiration
+* etc
\ No newline at end of file