https://github.com/sakan811/kana-flashcard-web-app

Japanese Kana Flashcard Web App for practicing Japanese kana, e.g., Hiragana and Katakana
https://github.com/sakan811/kana-flashcard-web-app

flashcard flashcards hiragana japanese japanese-language japanese-study javascript katakana nodejs postgres postgresql react reactjs web webapp website

Last synced: 8 months ago
JSON representation

Japanese Kana Flashcard Web App for practicing Japanese kana, e.g., Hiragana and Katakana

• Host: GitHub
• URL: https://github.com/sakan811/kana-flashcard-web-app
• Owner: sakan811
• Created: 2024-07-20T17:37:10.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2025-01-22T06:51:48.000Z (9 months ago)
• Last Synced: 2025-01-22T07:35:29.735Z (9 months ago)
• Topics: flashcard, flashcards, hiragana, japanese, japanese-language, japanese-study, javascript, katakana, nodejs, postgres, postgresql, react, reactjs, web, webapp, website
• Language: TypeScript
• Homepage: https://kana-flashcard-web-app-671v.vercel.app
• Size: 656 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Japanese Kana Flashcard Web App

A **Japanese Kana Flashcard** Web App for **practicing** Japanese Kana, e.g., Hiragana and Katakana.

The web-app was built to run **locally**.

# Status

[![Backend Test](https://github.com/sakan811/kana-flashcard-web-app/actions/workflows/test-backend.yml/badge.svg)](https://github.com/sakan811/kana-flashcard-web-app/actions/workflows/test-backend.yml)

[![Frontend Test](https://github.com/sakan811/kana-flashcard-web-app/actions/workflows/test-frontend.yml/badge.svg)](https://github.com/sakan811/kana-flashcard-web-app/actions/workflows/test-frontend.yml)

[![Frontend Test Demo](https://github.com/sakan811/kana-flashcard-web-app/actions/workflows/test-frontend-demo.yml/badge.svg)](https://github.com/sakan811/kana-flashcard-web-app/actions/workflows/test-frontend-demo.yml)

[![Push to Docker Hub](https://github.com/sakan811/kana-flashcard-web-app/actions/workflows/docker-push.yml/badge.svg)](https://github.com/sakan811/kana-flashcard-web-app/actions/workflows/docker-push.yml)

[![Trivy Docker Image Scan](https://github.com/sakan811/kana-flashcard-web-app/actions/workflows/trivy-scan.yml/badge.svg)](https://github.com/sakan811/kana-flashcard-web-app/actions/workflows/trivy-scan.yml)

# How to Use the Web App 

## Demo Version

- Navigate to https://kana-flashcard-web-app-671v.vercel.app/

## Full Version

### Setup the Web App 

- Download [docker-compose.yml](docker-compose.yml) file and place at any place of your choice.

- Download and install [Docker Desktop](https://www.docker.com/products/docker-desktop/)

- Open **Terminal** console

- Use `cd` command to navigate to the directory where you saved the `docker-compose.yml` file

  - For example: `cd /path/to/directory/`

- Type ```docker-compose up -d``` and enter

  - You can set Postgres port by running `export POSTGRES_PORT=port_number` before ```docker-compose up -d```:  

    - For example:  

      ```bash

      export POSTGRES_PORT=5501

      ```

    - Default Postgres port is **5432**

### Run the Web App

- Make sure that **Docker Desktop** is running

- Navigate to http://localhost:3000/