Thank you for considering contributing to our project! Here are some guidelines to help you get started.
- Fork the repository and clone it locally.
- Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature-name
- Make your changes and commit them:
git commit -m 'Describe your changes'
- Push your changes to your fork:
git push origin feature/your-feature-name
- Create a pull request to the
main
branch.
- Install dependencies:
npm install
- Create a
.env
file in the root of the project and add the following:cp .env.example .env
- Start the development server:
npm run dev
- Open http://localhost:3000 in your browser.
The documentation is available in the docs
folder. You can view it by going to http://localhost:3000/docs/home in your browser.
- Check out the roadmap items
- Add language support by following the i18n guide