- Install rye
- Run
rye sync
to install dependencies - Populate your
.env
file with the required variables if they aren't in your environment alreadyDB_NAME
- The name of the database to useDB_USER
- The username to use when connecting to the databaseDB_HOST
- The host to connect toDB_PASSWORD
- The password to use when connecting to the databaseDB_SSLMODE
- The SSL mode to use when connecting to the database. Defaults to `disableDB_PORT
- The port to connect to. Defaults to5432
DB_URI
- alternatively, you can just use a postgres database URI to connect to the databaseMOCK_FRAPPE_CLIENT
- This can be used if Frappe's book API is down, set it to true to use a mock client instead
- Run database migrations by running
rye run migrate
- Start the server by running
rye run devserver
- They can be found here
- A version of this application is deployed here