Joyful personal finance management for everyone.
Looking for collaborators! https://discord.gg/HwZarY9Aas
Joey Yu ๐ป ๐ |
Akwan Maroso ๐ป |
Sam Zhang ๐ป |
hanzi ๐ป |
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
.
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
We are using Jet to generate DB related stuff for a type-safe query building experience.
just jet
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
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
This will run all the tests for the server and the web.
just test
To run the project, simply use just dev
.