Skip to content

HACKING.md

Latest commit

 

History

History
87 lines (64 loc) · 2.83 KB

HACKING.md

File metadata and controls

87 lines (64 loc) · 2.83 KB

Getting Started

To run the project locally, you need the following CLI tools:

The following ports also must be free on your machine:

  • 5432 for PostgreSQL
  • 8000 for this application

You will need to bootstrap the app and database by performing on offline compilation using ./sqlx-data.json -- there's a handy make rule to get you started;

make bootstrap

After running the bootstrap rule, the app will be running, but it won't live-reload. To run the typical dev scripts, stop the app and run the dev rule:

make dev

There are very few unit tests, but you can run them with:

cargo test

There are some utilities in the Makefile for working with the database. In particular:

make shell-db  # attach to an interactive PostgreSQL shell inside the DB
make watch-db  # live-tail the database logs

Additionally, there is a rule for running CI just like it runs in CI!

make check

You will notice that there is a pre-push hook in ./githooks which calls this Make rule. I recommend running git config --local core.hooksPath githooks to setup githooks for your local repo, which will run the checks locally before you push, giving some faster feedback. This is only truly crucial if you're given permission to push directly to the main branch, though, since CI will run these same checks for pull requests anyway.

Other Database Options

Of course, the application will happily converse with any PostgreSQL instance. You can easily direct the program to your PostgreSQL instance of your choosing by simply changing the .env file. Note that the .env file is created by copying env-template the first time you run make dev. Naturally, it contains other handy config levers.

Note that the application only uses DATABASE_URL. The rest of the POSTGRES_* environment variables are only used in the Makefile and passed to the PostgreSQL Docker container during startup.

Auth & Getting Around

Navigation and flows between routes has generally not yet joined the chat, so you need to know where to go if you're running the app locally:

  • /authentication/register to make an account
  • /authentication/login to log in if you already did so
  • /collection/1 to view the one and only default collection, though you'll be redirected to /authentication/login if you've not authenticated yet.
  • to logout, if you wish, delete your cookies!

Once you get to /collection/1, there's a more complete navigation experience between the 3 views there:

  • main view (/collection/1)
  • add page (/collection/1/new-page)
  • reorder columns (/collection/1/prop-order)