diff --git a/README.md b/README.md index 247abdf..a3bed23 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,31 @@
  • Add token/cookie(?) authentication
  • -#Let's keep updating this readme.md file as we complete our tasks +# Let's keep updating this readme.md file as we complete our tasks + +## How to launch +First, make sure that python is installed. Create a virtual environment (if you want to) +``` +python -m venv venv +source /venv/bin/activate +``` +(not necessary) + +run the docker image provided to launch postgresql (telegram) + +install dependencies: +``` +pip install -r requirements.txt +``` + +open terminal in the **app** directory, and launch with: +``` +uvicorn main:app --reload +``` +OR +``` +python3 -m uvicorn main:app --reload +``` ## Git Guide - [Git Reference](http://git.github.io/git-reference): despite its name it is more of a user guide.