README.md

🍺 PYCONT

A perpetually incomplete personal finances app

Installation

1. Clone the project

2. Copy the env.XXX.tplto .env and fill in the required information, note that there are two of them, each one suitable for a different environment.

3. run docker-compose up -d

4. pycont is now running, and accessible through: http://localhost:$NGINX_HTTP_PORT

5. Only in production: Pycont will only work behind https, you can find examples of configuration in the doc folder

6. Run initial migrations

   docker-compose exec pycont-api ./manage.py migrate

7. Bootstrap initial users (admin:admin)

   docker-compose exec pycont-api ./manage.py loaddata users

8. You can now create users via de Django administration backoffice on http://localhost:$NGINX_HTTP_PORT/api/admin/

API Documentation

Pycont uses swagger, you can access it via http://localhost:$NGINX_HTTP_PORT/api/doc/swagger