Skip to content

Kanau is an educational web app to aid knowledge retention for Japanese learners through the presentation of flashcards plus a self-hosted JP-ENG Dictionary. The review interval of these flashcards is calculated based on how well a user remembers them.

DLSU-CCAPDEV/2021T2-G41

Repository files navigation

Kanau

forthebadge License License

Kanau is an educational web app to aid knowledge retention for Japanese learners through the presentation of flashcards. The review interval of these flashcards are calculated based on how well a user remembers them. It also contains a self-hosted Japanese Dictionary, complete with sample sentences and an easy add-to-card feature. Click here for the full specification of the project.

Heroku Deployed Application

Setting Up the Server Locally

Prerequisites

Installation

  1. Clone the project either by directly downloading the repository here, or using the command below.
    (Note: git should be installed in your system for you to be able to use this command).
git clone https://github.com/DLSU-CCAPDEV/2021T2-G41
  1. Open Command Prompt.

  2. Navigate to the project folder - the folder containing the contents of the cloned or downloaded repository.

  3. Run the command npm install to initialize and install all necessary modules used in the project.

  4. To run the server locally, a .env file is required. It was not included in the repository since it contains sensitive information. Please ask the owners for the .env file. Once acquired, place the .env file in the root directory of the project.

Running the Application

  1. Open Command Prompt.

  2. Navigate to the project folder - the folder containing the contents of the cloned or downloaded repository.

  3. Run the command node app.js. If the app is working properly, your Command Prompt should display the following statement:

Server is running!
  1. Open a web browser and type the following URL:
http://localhost:3000/

Dummy Accounts

Email Password
markadriii@gmail.com vTx2QQAz
gab@gmail.com T6yGQPsj
mitch@gmail.com gU7SFDv4
ashlee_19@gmail.com yP5Mq61Q
astherielle@gmail.com cvIyU23B

Dependancies

Built with

Authors

About

Kanau is an educational web app to aid knowledge retention for Japanese learners through the presentation of flashcards plus a self-hosted JP-ENG Dictionary. The review interval of these flashcards is calculated based on how well a user remembers them.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published