Skip to content

Latest commit

 

History

History
118 lines (80 loc) · 4.77 KB

README.md

File metadata and controls

118 lines (80 loc) · 4.77 KB
Raw

This is the www.emfcamp.org web site, built with Flask & Postgres by the EMF web team.

Deploy Status Coverage Status

Get Involved

If you want to get involved, the best way is to join us on IRC, on #emfcamp-web on irc.libera.chat.

Join with IRCCloud:

Getting Started

The only supported way to develop is to use Docker with Docker Compose (on Linux you'll need to install Docker Compose separately) version 1.24.0 or newer.

Lazydocker is highly recommended to monitor the containers.

To start all containers (and rebuild any which may have changed):

Tip

Apple Silicon Users You'll probably want to build your own version of the base images as well, as the ones we build are amd64 only, and so painfully slow on ARM devices. This is unlikely to be resolved until GitHub Actions has ARM runners.

docker build -t ghcr.io/emfcamp/website-base -f ./docker/Dockerfile.base .
docker build -t ghcr.io/emfcamp/website-base-dev -f ./docker/Dockerfile.base-dev .
docker compose build --parallel
docker compose up

You should then be able to view your development server on http://localhost:2342.

To create some fake data in your DB, run:

./flask dev data

To stop all containers, use docker compose stop To delete all data and start over fresh you can use docker compose down.

Management commands can be listed and run using the ./flask command, which forwards them to the flask command line within the container.

Visual Studio Code

If you use Visual Studio Code it should present you with the option to open the project in a dev container. If not, run code . from your local copy, and ensure you have the Dev Containers extension installed.

Reopening in a dev container will start everything via Docker, attach your VSCode instance to the application container, install relevant extensions, and ensure everything is configured to fit with our standards.

The first time you start the dev container you will need to tell VSCode where to find the Poetry virtual environment. You can do this by open the command palette (Cmd-P on macOS devices) and searching for "Python: Select interpreter", the list presented should include website-${randomHash}-py3.11, which will be annotated as "Poetry". Select that, and then any Python tooling and shells will run within the appropriate virtualenv.

Errors starting the dev server

e.g. Error: While importing 'dev_server', an ImportError was raised.

If you've just updated and you're seeing errors when starting the dev server, first make sure you try:

    docker compose up --build

Tests

Tests are run using the ./run_tests script.

Code Style

For Python, we currently use Ruff to enforce code style. These checks are run by ./run_tests.

However, it's easy to forget these checks, so you can also run them as a git pre-commit hook using pre-commit. To set this up on the host where you'll be using git:

pip3 install pre-commit
pre-commit install

Adding accounts

Once you've created an account on the website, you can use ./flask make_admin to make your user an administrator. Or, you can create an account and simultaneously make it an admin by using ./flask make_admin -e [email protected]

E-mail sending is disabled in development (but is printed out on the console). You can also log in directly by setting BYPASS_LOGIN=True in config/development.cfg and then using a URL of the form e.g. /login/[email protected].

Database Migrations

  • ./flask db migrate -m 'Migration name' to generate migration scripts when models have been updated.
  • ./flask db upgrade to run any migration scripts you've generated (or populate a fresh DB).
  • ./flask db downgrade to undo the last migration.

For more migration commands, see the flask-migrate docs.

More Docs

For more, see: