良いね iine

A Japanese learning site with an RPG twist

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Start
   • Test
3. Usage
4. Future roadmap
5. Contributing
6. Contact
7. Acknowledgments

About The Project

良いね iine is a Japanese learning website mixed with RPG game elements.

Users can sign up, create a character for the game, and gain coins and experience by playing Japanese quizzes. Users can also buy new outfits with coins and change them in their wardrobes.

They can always check their achievments and learning progress by reviewing the records of the words they've learned.

(back to top)

Built With

• React
• Redux toolkit
• Node.js
• Express.js
• MongoDB
• Tailwind
• Cypress
• Jest

(back to top)

Getting Started

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/SimpleLuke/japanese-learning-RPG.git

2. Install NPM packages

   cd frontend/
   npm install
   cd backend/
   npm install

3. Install MongoDB

   brew tap mongodb/brew
   brew install [email protected]
   

4. Start MongoDB

   brew services start [email protected]
   

Start

1. Start the frontend server

   cd frontend/
   npm start
   

2. Start the backend server

   cd backend/
   npm start
   

3. Browse to http://localhost:3000

Test

• Run all frontend tests

  npm test
  

• Run frontend component tests

  npm test:unit
  

• Run frontend end-to-end tests

  npm test:feature
  

• Run all backend tests

  npm test
  

(back to top)

Usage

• Sign up an account

• Choose your character

• Navigate to different features

• Play a Japanese quiz to earn exp and coins through study desk

• Buy new outfit with your coins in the shop

• Change outfit in the wardrobe

• View learning progress through the bookshelf

• View your achievments through the stats bar

• Toggle background music and logout through menu

  

(back to top)

Future roadmap

• Host the site
• Add different categories to the quiz
• Add health bar

(back to top)

Contributing

Contributions make the open-source community a fantastic place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion to improve this, please fork the repo and create a pull request. You can also open an issue with the tag "enhancement". Remember to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

• Anna Magnusson - LinkedIn - [email protected]
• Edward Thomas - LinkedIn - [email protected]
• James Mcleish - LinkedIn - [email protected]
• Luke Lai - LinkedIn - [email protected]
• Ryan Lai - LinkedIn - [email protected]

Project Link: [japanese-learning-RPG]

(back to top)

Acknowledgments

• Makers
• Tailwind CSS
• TailwindUI
• Headless UI
• Heroicons
• Tailwind Cheat Sheet
• MDN Web Docs
• W3Schools

(back to top)