Naija-Guru/naija-guru-web

Naija Guru web apps: spell checker, translator, etc. Naija Spell Checker ## Getting Started Naija Spell Checker is an Open Source proofreading software for Pidgin English. The Naija Spell Checker (this repo) is freely available under the MIT license. ## Development This monorepo uses Turborepo ### Apps and Packages - `apps/editor/`: The Naija spell checker editor website - `apps/chrome-extension/`: The Naija spell checker chrome extension ### Build To build all apps and packages, run the following command: ``` yarn build ``` ### Develop To develop all apps and packages, run the following command: ``` yarn dev ``` ## Contribution Guidelines Are we missing any of your favorite features, which you think you can add to it. We invite you to contribute to this project. To start contributing, follow the below guidelines: **1.** Fork this repository. **2.** Clone your forked copy of the project. ``` git clone github.com /naija-spell-checker.git ``` **3.** Navigate to the project directory :file_folder: . ``` cd naija-spell-checker ``` **4.** Add a reference(remote) to the original repository. ``` git remote add upstream github.com ``` **5.** Check the remotes for this repository. ``` git remote -v ``` **6.** Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository). ``` git pull upstream main ``` **7.** Create a new branch. ``` git checkout -b ``` **8.** Implement your desired changes. **9.** Track your changes . ``` git add . ``` **10.** Commit your changes . ``` git commit -m "Relevant message" ``` **11.** Push the committed changes in your feature branch to your remote repo. ``` git push -u origin ``` **12.** To create a pull request, click on `**compare and pull requests**`. **13.** Add appropriate title and description to your pull request explaining your changes and efforts done. **14.** Click on `Create Pull Request`. **15.** Wait for your submi …