Skip to content

Latest commit

 

History

History
108 lines (73 loc) · 3.52 KB

README.md

File metadata and controls

108 lines (73 loc) · 3.52 KB
Raw

Fijoy

All Contributors

Joyful personal finance management for everyone.

Looking for collaborators! https://discord.gg/HwZarY9Aas

Fijoy Home

Contributors

Joey Yu
Joey Yu
💻 📖		 Akwan Maroso
Akwan Maroso
💻		 Sam Zhang
Sam Zhang
💻		 hanzi
hanzi
💻

Contribution

Make sure you have Just installed to run just commands. And do a quick just init to grab all the dependencies.

The next step is to setup all the environment variables.

You can find more details in apps/server/.env.example and apps/web/.env.example.

Proto

We use protobuf to define the API for the server and the web. To generate all the necessary code, run the following commands:

just buf

Server

We are using Jet to generate DB related stuff for a type-safe query building experience.

just jet

Database

All database migrations are in apps/server/internal/database/migrations. Here are all the migration commands:

just db-up
just db-down
just db-force <version>

To start a local Postgres instance with Docker, you can use:

just postgres

Web

Kanel is used to generate all the TypeScript types and Zod schemas from Postgres schemas on a live Postgres database instance. It will use the DB_URL from apps/server/.env.

just kanel

Test

This will run all the tests for the server and the web.

just test

To run the project, simply use just dev.