Browse Source

Merge pull request #4 from shinbay-almaz/Madi

updated readme
main
Madiwka 1 year ago
committed by GitHub
parent
commit
01ac3ca498
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 1 deletions
  1. +25
    -1
      README.md

+ 25
- 1
README.md View File

@@ -8,7 +8,31 @@
<li> Add token/cookie(?) authentication </li>
</ul>

#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.


Loading…
Cancel
Save