Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 2.98 KB

README.md

File metadata and controls

65 lines (40 loc) · 2.98 KB
Raw

Game Night

This project is intended to allow groups of friends to organize game nights.

Goals

  • People can invite new members to the group and admins can grant approval.
  • People can host game nights with specific games in mind or a selection of options from everyone's boardgame libraries.
  • People can express their dietary needs so that food plans accommodate everyone.
  • Frequent, pre-planned boardgame nights make people not feel left out if they can't make a specific night.

Local Development

For local development, just is used to automate common workflows (see justfile).

Configuration

SendGrid

For email to work for login links, you will need a SendGrid token. You can find generate a new one under Settings > API Keys and either add it to your environment as EMAIL_TOKEN when running the application or store it in app_config.toml under the key email_token.

Development Tooling

Nix

If you are using nix, there is a nix flake that defines a devShell environment with all of the necessary dependencies for development. direnv is recommended to automatically apply this devShell when you are working in this directory.

Non-Nix

You'll want to install the following tools:

Docker / Postman

The local development infrastructure is written to be compatible with both Docker and Podman when configured to replace the docker command.

Workflows

Database

To get started with a local database, you'll want to:

  1. just database-start to pull a PostgreSQL image and start a container
  2. just database-create to initialize the game-night-db
  3. just database-migrate to run the existing migrations
    • This is not needed, since the app runs migrations on startup, but is a good smoke test
  4. just database-shell to get a psql session in the game-night-db to further smoke test

After making changes to the database via migrations, run just database-prepare-for-ci to re-generate the sqlx-data.json file that ensures that the compile time checks of the SQL queries are up to date and correct.

Application

  1. just build-backend to build a release version of the backend application
  2. just run-app to start a local running instance that connects to the containerized PostgreSQL instance

License

This software is licensed under the BGDC License.