Thank you for your interest in contributing to oss.now! This guide will help you set up your development environment and understand our workflow.
-
Clone the repository
git clone https://github.com/ossdotnow/ossdotnow.git cd ossdotnow -
Install dependencies
bun install
-
Set up environment variables
Make a copy of
.env.exampleand replace values with your own. -
Start the database services
bun docker:up
-
Run database migrations
bun db:migrate
-
Seed the database (optional)
bun db:seed
-
Start the development server
bun dev
The application will be available at
http://localhost:3000
Note: Make sure to not have any other Next.Js runnning or OAuth flows may not work correctly.
-
Look through the available issues/bugs
If you have haven't got an issue assigned to you, please look through the list of issues and bugs and drop a comment, someone will assign it to you as soon as possible. Do not start work on it without being assigned.
-
Create a new branch for your feature or bugfix:
Always branch off from the
devbranch (notmain).
git checkout -b feature/your-feature-name-
Make your changes and commit them with descriptive messages.
-
Push your branch and create a pull request.
If you have any questions or need help with your contribution, please open reach out on Discord.
Thank you for contributing to oss.now!