Budgeteer

Prerequisites

To get started with Budgeteer, ensure that you have the following tools installed and properly configured on your system:

1. Docker: A platform to develop, ship, and run applications using containers.
   • Installation guide: Install Docker
2. Docker Compose: A tool for defining and running multi-container Docker applications.
   • Installation guide: Install Docker Compose
3. Bun: A runtime that serves as a drop-in alternative to Node.js.
   • Installation guide: Install Bun

Setup

Clone the repo onto your local machine.

git clone https://github.com/0-BSCode/Budgeteer.git

Depending on your preference, we have a Docker setup or a manual setup

Using Docker

Run the following command to initialize the required services using Docker Compose:

# Executes the Docker Compose configuration for development
bun run all:up

Manual

Run the following command to install all project dependencies.

# Installs project dependencies
bun install

Run the following command to start all services.

bun run all:dev

Note

On the first run, startup may take a few minutes as it requires setting up a Docker container for the database.

Setting Up Environment Variables

Tip

By default, the environment variables are set to placeholder fallbacks to ensure the app works without any configuration.

If you want to setup your own environment variables, make a copy of the .env.example first.

# creates a .env to read from when executing the Docker Compose file
cp .env.example .env

# start editing it
nano .env