FinTrack

The student-friendly finance tracker that makes expense tracking and budget projection.

Local Development

1. Pre-requisites

Install Docker

• Install the Docker Desktop app on your local machine, and run the app.

• Install Docker via Docker CLI. For this method, Docker Compose must also be installed separately.

Verify installation

docker-compose --version
docker --version

Install Bun

Install Bun on your local machine.

2. Clone the repo

git clone gh repo clone chingu-voyages/V55-tier3-team-35
cd V55-tier3-team-35

3. Install dependencies

install shared dependencies, client, and server dependencies in one command

bun run install:all

4. Set Up Environment Variables

In the apps/server folder, create a .env file based on the env.example file and add the secret keys

5. 4. Prisma Setup (If DB schema was changed in Supabase)

Whenever changes are made directly in Supabase (e.g. new tables):

cd apps/server
bunx prisma db pull      # Pulls schema from Supabase into Prisma
bunx prisma generate     # Regenerates the Prisma client

6. Run the app in development

In the root of the project, run the following command to start the app in development mode:

docker-compose -f docker/docker-compose.dev.yml up --build

This command will build the Docker containers and start the application in development mode.

Accessing the App

• Frontend: http://localhost:5173
• Backend: http://localhost:3000

Stopping the Containers

To stop the running containers, press CTRL + C in the terminal or run:

docker-compose -f docker/docker-compose.dev.yml down

Rebuilding the Containers

docker-compose -f docker/docker-compose.dev.yml up --build

Viewing Logs

To view the logs of a specific container, use:

docker-compose -f docker/docker-compose.dev.yml logs -f [service-name]

Replace [service-name] with backend or frontend as applicable.

Our Team

Everyone on your team should add their name along with a link to their GitHub & optionally their LinkedIn profiles below. Do this in Sprint #1 to validate your repo access and to practice PR'ing with your team before you start coding!

• Syed Affan #1: GitHub / LinkedIn
• Dorene St.Marthe #2: GitHub / LinkedIn
• Steffi Saint-Pierre #3: GitHub / LinkedIn
• Shaimaa #4: GitHub / LinkedIn
• Jack Li #5: GitHub / LinkedIn
• Kuro #7: GitHub / LinkedIn