Add README

This commit is contained in:
Tanner Collin 2018-05-03 17:58:56 +00:00
parent 27273b8ebc
commit 253972340c

21
README.md Normal file
View File

@ -0,0 +1,21 @@
# telegram-archivist
## Development (Quickstart)
* Install dependencies:
```text
$ sudo apt-get install python3 python3-pip virtualenv python3-virtualenv
```
* Setup the virtual environment with python3
```text
$ virtualenv -p python3 env
```
* Activate the environment, install dependencies, perform DB migration
```text
$ . env/bin/activate
(env) $ pip install -r requirements.txt
(env) $ python manage.py migrate
(env) $ python manage.py runserver
```
If you get a no such table error, try: `python manage.py migrate --run-syncdb`