Notebook

A notebook app.

Notebook is free and open source software licensed under the MIT Licence.

Development

The whole project is orchestrated using Docker Compose and Docker Swarm, with a PostgreSQL database and a Traefik load-balancer and router.

This project is loosely based on full-stack-fastapi-postgresql.

File Structure

Each folder should contain a README.md file explaining the purpose of its direct children, and other development details for the contents of the folder. In the root project folder:

• README.md - overall documentation of the project
• CONTRIBUTING.md - guidelines for contributing to the project
• LICENCE.md - contains the MIT Licence
• LICENSE.md - a symlink to LICENCE.md for people who can't spell speak American English
• docker-compose.yml - contains defaults for running the full application stack (see https://docs.docker.com/compose/)
• docker-compose.override.yml - contains useful overrides of values in docker-compose.yml for development (see https://docs.docker.com/compose/extends/#multiple-compose-files)
• frontend/ - contains the Vue frontend source code
• backend/ - contains the Python backend source code