1.5 KiB
ATST
Installation
script/setup
The setup script installs pipenv, which is what this application uses to manage its dependences and virtualenv. Instead of the classic requirements.txt file, pipenv uses a Pipfile and Pipfile.lock, making it more similar to other modern package managers like yarn or mix.
To enter the virtualenv manually (a la source .venv/bin/activate):
pipenv shell
If you want to automatically load the virtual environment whenever you enter the project directory, take a look at direnv. An .envrc file is included in this repository. direnv will activate and deactivate virtualenvs for you when you enter and leave the directory.
Additionally, ATST requires a redis instance for session management. Have redis installed and running. By default, ATST will try to connect to a redis instance running on localhost on its default port, 6379.
Running (development)
To start the app locally in the foreground and watch for changes:
script/dev_server
Testing
To run all linting and tests:
script/test
To run only the unit tests:
pipenv run python -m pytest
To re-run tests each time a file is changed:
pipenv run ptw
Notes
tornado templates are like mustache templates -- add the
following to ~/.vim/filetype.vim for syntax highlighting:
:au BufRead *.html.to set filetype=mustache