diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..74f9a73e --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,48 @@ +# Contributing to Kener + +Thank you for considering contributing to our project! Here are some guidelines to help you get started. + +--- + +## How to Contribute + +1. Fork the repository and clone it locally. +2. Create a new branch for your feature or bug fix: + ```bash + git checkout -b feature/your-feature-name + ``` +3. Make your changes and commit them: + ```bash + git commit -m 'Describe your changes' + ``` +4. Push your changes to your fork: + ```bash + git push origin feature/your-feature-name + ``` +5. Create a pull request to the `main` branch. + + +## Development + +1. Install dependencies: + ```bash + npm install + ``` +2. Create a `.env` file in the root of the project and add the following: + ```bash + cp .env.example .env + ``` +2. Start the development server: + ```bash + npm run dev + ``` +3. Open [http://localhost:3000](http://localhost:3000) in your browser. + +## Documentation + +The documentation is available in the `docs` folder. You can view it by going to [http://localhost:3000/docs/home](http://localhost:3000/docs/home) in your browser. + +## Where to Start + +1. Check out the [roadmap items](https://kener.ing/docs/roadmap/) +2. Add language support by following the [i18n guide](https://kener.ing/docs/i18n/) \ No newline at end of file diff --git a/docs/i18n.md b/docs/i18n.md index 6d390641..c7738eae 100644 --- a/docs/i18n.md +++ b/docs/i18n.md @@ -129,7 +129,7 @@ Open `src/lib/i18n/client.js` and add the locale code to the `locales` array. import { ru, enUS, hi, de, zhCN, vi, ja, nl, da, fr, ko } from "date-fns/locale"; ``` -This should be valid for the date-fns library. +This should be valid for the date-fns library. You can find the list of locales [here](https://github.com/date-fns/date-fns/blob/9bb51691f201c3ec05ab832acbc5d478f2e5c47a/docs/i18nLocales.md). Next add a mapping in the `locales` object.