[ OPEN SOURCE · AGPL-3.0 ]
Help build ReachConvert
Bug reports, documentation fixes, and pull requests are all welcome. Here is how to get set up and get your change merged.
[ REPOSITORIES ]
Two repos, one product
[ WAYS TO HELP ]
Every contribution counts
Report a bug
Open an issue with steps to reproduce, what you expected, and what actually happened. Logs and screenshots help.
Suggest a feature
Open an issue describing the problem first. Agreeing on the approach before coding saves rework.
Improve the docs
Product guides are authored in src/lib/docs.ts in the frontend repo. Typos and unclear steps are fair game.
Send code
Pick an open issue or fix something you ran into. Small, focused pull requests get reviewed fastest.
[ LOCAL SETUP ]
Run it on your machine
You need Node.js 20+, npm, and a MongoDB instance (local or hosted). Fork both repos, then start the backend before the frontend.
git clone https://github.com/<your-username>/AgentReach-backend.git
cd AgentReach-backend
npm install
cp .env.example .env
npm run start:devAPI on http://localhost:3001/api · Swagger UI on /docs
git clone https://github.com/<your-username>/AgentReach-frontend.git
cd AgentReach-frontend
npm install
cp .env.example .env
npm run devSet NEXT_PUBLIC_API_URL=http://localhost:3001/api in .env
[ PULL REQUESTS ]
From fork to merge
- 01 / STEP
Fork and branch
Fork the repository and create a branch from main, e.g. fix/campaign-pagination.
- 02 / STEP
Keep it focused
One change per pull request. Match the style of the surrounding code.
- 03 / STEP
Check it locally
Run npm run lint and npm run build in the repo you changed. In the backend, also run npm test.
- 04 / STEP
Open the pull request
Target main, explain what changed and why, and add screenshots for UI changes.
Licensed under AGPL-3.0
ReachConvert is released under the GNU Affero General Public License v3.0. By opening a pull request, you agree that your contribution is licensed under the same terms.
Read the licenseQuestions first?
Not sure where to start or whether an idea fits? Get in touch before you write code.
Can't contribute code right now? Support the project instead.