Local Setup

This section will guide you through the process of setting up the application on your local machine.

Requirement

The following are required to run the application in development.

  • Rust v1.63 or greater
  • PostgreSQL PostgreSQL server v14.5 or greater
  • sqlx for interacting with the database,
  • sqlx-cli, a command line tool for sqlx,
  • cargo watch, a tool for watching the project files and recompiling when they change,

Installation (development)

To run the application in development mode, follow the steps below

  1. clone Repository
  2. copy and populate .env.example to .env cp .env.example .env, paying attention to the SECRET and DATABASE_URL variables
  3. Run sqlx database create to create the database from the specified DATABASE_URL Use SQL database drop to revert the change
  4. Run SQL migrate run to run the migrations
  5. use SQL migrate add <migration_name> to add a new migration