diff --git a/README.md b/README.md new file mode 100644 index 0000000..bc4ff8c --- /dev/null +++ b/README.md @@ -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`