January 1, 2025

Contributing to Rox

Thank you for your interest in contributing to Rox! We welcome contributions from the community to help make Rox better.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please treat everyone with respect and kindness.

Getting Started

Prerequisites

Bun: v1.0.0 or higher
Node.js: v18 or higher (for some tools)
Docker: For running the database and services

Setting Up Your Environment

Fork the repository on GitHub.

Clone your fork:

git clone https://github.com/YOUR_USERNAME/rox.git
cd rox

Install dependencies:
```
bun install
```
Start the database:
```
docker compose up -d
```
Run migrations:
```
bun run db:migrate
```
Start the development server:
```
bun run dev
```

The backend API will be available at http://localhost:3000, and the frontend client at http://localhost:3001.

Development Workflow

Create a branch for your feature or fix:
```
git checkout -b feature/my-new-feature
```
Make your changes. Ensure you follow the project's coding style.
Run tests to ensure no regressions:
```
bun test
```

Commit your changes using conventional commits:

git commit -m "feat: add new awesome feature"

Push to your fork:
```
git push origin feature/my-new-feature
```
Open a Pull Request on the main repository.

Project Structure

src/backend: Hono API server
src/frontend: Waku client application
src/shared: Shared types and utilities
drizzle: Database schema and migrations

Reporting Issues

If you find a bug or have a feature request, please open an issue on GitHub. Provide as much detail as possible, including steps to reproduce the issue.

License

By contributing, you agree that your contributions will be licensed under the project's MIT License.