Skip to content

Latest commit

 

History

History
101 lines (68 loc) · 3.35 KB

README.md

File metadata and controls

101 lines (68 loc) · 3.35 KB
Raw

Fijoy - Joyful Net Worth Tracking

All Contributors

Personal finance made simple. Track your net worth, manage your assets, and grow your wealth.

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 # your database must be running

Database

All database migrations are in apps/server/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

Test

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

just test

To run the project, simply use just dev.