OutReachKenya is an open-source web application aimed at empowering Kenyans to report human rights violations and other grievances to government bodies, international organizations, and human rights organizations. This project provides a streamlined platform for users to create and send emails, ensuring their voices are heard.
This project is a monorepo containing both the server and client applications. To get started, clone the repository and follow the instructions for the server and client applications.
The server is built using Elysia with the Bun runtime.
To start the development server, run:
bun run devThe client is built using Remix.
To start the development server, run:
bun run devIf you're familiar with deploying Node applications, the built-in Remix app server is production-ready. Make sure to deploy the output of npm run build.
- build/server
- build/client
To build your app for production, run:
npm run buildThen run the app in production mode:
npm startThis template comes with Tailwind CSS already configured for a simple default starting experience. You can use whatever css framework you prefer. See the Vite docs on css for more information.
We welcome contributions to OutReachKenya! Here’s how you can get started:
- Fork the repository: Click the "Fork" button at the top right of this page to create a copy of this repository in your GitHub account.
- Clone your fork: Clone your forked repository to your local machine.
git clone https://github.com/your-username/outreach-kenya.git- Create a branch: Create a new branch for your feature or bugfix.
git commit -m "Description of your changes"- Make your changes: Make your changes to the codebase.
- Commit your changes: Commit your changes with a clear message.
git commit -m "Description of your changes"- Push to your fork: Push your changes to your forked repository.
git push origin my-feature-branch- Create a pull request: Go to the original repository and create a new pull request from your fork.