Add docs, for sake of quick start guide

This commit is contained in:
Lance Edgar 2021-01-27 17:30:55 -06:00
parent f6cf02bcaf
commit 93fad98008
6 changed files with 162 additions and 0 deletions

31
docs/quickstart.rst Normal file
View file

@ -0,0 +1,31 @@
.. highlight:: sh
Quick Start
===========
This should get you up and running in minutes, with a "bare" Theo setup,
meaning no POS integration.
Clone the source code for Theo wherever you like, e.g. ``~/src/theo``::
mkdir -p ~/src
cd ~/src
git clone https://kallithea.rattailproject.org/rattail-project/theo
Your local PostgreSQL service should be available, and user (named ``rattail``)
and DB (named ``theo``) created::
sudo apt install postgresql
sudo -u postgres createuser -P rattail
sudo -u postgres createdb -O rattail theo
Make and activate a virtual environment, e.g. ``/srv/envs/theo``::
mkdir -p /srv/envs
python -m venv /srv/envs/theo
source /srv/envs/theo/bin/activate
With the virtual environment active, run the development bootstrap script::
python ~/src/theo/dev/bootstrap.py