Thank you for your interest in contributing to the Soundable API! This document outlines the steps to get started with the project, how to make changes, and how to submit your contributions.

You need to have Bun installed to run the project. If you don't have it installed, you can follow the instructions on their website.

# Clone the repository locally.
git clone https://github.com/SoundableHQ/API
cd API

# Install the dependencies.
bun install

Once all setup is done, you can run the project using the following command.

# Automatically watches for changes and restarts the server.
bun dev

# Runs the server without restarting.
bun start

If you're doing any changes to the database schema, you have to generate a new migration file. You can do this by running the following command:

bun run db:migration-gen

Once you have made your changes and tested them, you can open a pull request (PR) to the main branch of the repository. Please ensure that your PR includes the following.

• A clear description of the changes you made
• Any links to relevant issues or discussions