aldy-san/zero-neko

This project is a website that provide dictionary and game to help everyone learn Japanese language.

A WEBSITE TO LEARN JAPANESE LANGUAGE 🌱

• This project is a website that provide dictionary and game to help everyone learn Japanese language.
• This website made with ReactJS and TailwindCSS
• Data is fetced from kai.kanjiapi.dev and Jisho API
• Follow our Official Instagram acc for daily post Japanese lesson at @zeroneko.learn
• Feel free to star this repository, thanks.

📌How to run

1. Install packages using npm.

npm run install

2. Just run it.

npm run start

📌Contributing Guidelines

1. Fork this repository.

2. Clone your forked copy of the project.

git clone https://github.com/<your-github-username>/zero-neko.git

3. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/aldy-san/zero-neko

4. Check the remotes for this repository.

git remote -v

5. 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

6. Create a new branch.

git checkout -b <your_branch_name>

7. Perfom your desired changes to the code base.

8. Add your changes to staging area

git add .

9. Commit your changes .

git commit -m "Relevant message"

10. Push the committed changes in your feature branch to your remote repo.

git push -u origin <your_branch_name>

11. To create a pull request, click on compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repo you are suppose to make a PR to.

12. Add appropriate title and description to your pull request explaining your changes and efforts done. Always make sure you have pulled the latest code from the master branch before making a PR.

13. Click on Create Pull Request.

Hurray! You successfully made a contribution!