CONTRIBUTING.md

Contributing

Thank you for taking the time to contribute! Feel free to open issues or pull requests for any improvements or bugs you find.

Install Bun

https://bun.sh/

Clone Repository

  git clone https://github.com/nulfrost/precis

Go to the project directory

  cd precis

Install dependencies

  bun install

Environment Variables

Make a copy of the .env.example file and rename it to .env. Fill in the necessary environment variables.

Running the Project

Depending on what you're improving or fixing, you can run the following commands:

• bun run dev - Run the API, Drizzle Studio and the Frontend
• bun run dev:web - Run the frontend only
• bun run dev:api - Run the API only