-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #65 from kohei-s/deployment
Deployment
- Loading branch information
Showing
8 changed files
with
46 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,45 @@ | ||
|
||
# KoToKo: Japanese concentration game app | ||
This mobile application is developed 🛠️ as my personal capstone project for [Java Development Bootcamp at neue fische](https://www.neuefische.de/en/bootcamp/java-development) from May to August 2023 (try the latest version 👉 [Kotoko](https://kotoko.de)) | ||
This mobile application is originally developed as my Fullstack capstone project for [Java Development Bootcamp at neue fische](https://www.neuefische.de/en/bootcamp/java-development) 2023 (try the latest version 👉 [Kotoko](https://kotoko.de)) | ||
|
||
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=kohei-s_kotoko-concentration-app-frontend&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=kohei-s_kotoko-concentration-app-frontend) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=kohei-s_kotoko-concentration-app-frontend&metric=coverage)](https://sonarcloud.io/summary/new_code?id=kohei-s_kotoko-concentration-app-frontend) [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=kohei-s_kotoko-concentration-app-frontend&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=kohei-s_kotoko-concentration-app-frontend) \ | ||
\ | ||
![KoToKo_ver1](https://github.com/kohei-s/kotoko-concentration-app/assets/82062401/b4132c77-a729-490f-ac6c-150da692cf4d) | ||
(device pixel ratio: 390x844) | ||
--- | ||
Code analysis with SonarCloud | ||
- Frontend\ | ||
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=kohei-s_kotoko-concentration-app-frontend&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=kohei-s_kotoko-concentration-app-frontend) | ||
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=kohei-s_kotoko-concentration-app-frontend&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=kohei-s_kotoko-concentration-app-frontend) | ||
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=kohei-s_kotoko-concentration-app-frontend&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=kohei-s_kotoko-concentration-app-frontend) | ||
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=kohei-s_kotoko-concentration-app-frontend&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=kohei-s_kotoko-concentration-app-frontend) | ||
- Backend\ | ||
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=kohei-s_kotoko-concentration-app-backend&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=kohei-s_kotoko-concentration-app-backend) | ||
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=kohei-s_kotoko-concentration-app-backend&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=kohei-s_kotoko-concentration-app-backend) | ||
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=kohei-s_kotoko-concentration-app-backend&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=kohei-s_kotoko-concentration-app-backend) | ||
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=kohei-s_kotoko-concentration-app-backend&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=kohei-s_kotoko-concentration-app-backend) | ||
--- | ||
## 1. Concept 📱 | ||
New concentration game app aims to support learning Japanese for so called [third culture kids](https://en.wikipedia.org/wiki/Third_culture_kid) growing up speaking a different language in kindergarten or school. The name of the app *KoToKO (言と言)* is a neologism that could mean *Word & Word*. | ||
New concentration game app aims to support learning Japanese for so called [third culture kids](https://en.wikipedia.org/wiki/Third_culture_kid) growing up speaking a different language in kindergarten or school (👉 [references & sources in research](https://github.com/kohei-s/kotoko-concentration-app/wiki/References-&-Internet-Sourcese)). The name of the app *KoToKO (言と言)* is a neologism that could mean *Word & Word*. | ||
## 2. Problem 😦 | ||
- Difficulty of staying motivated to learn the Japanese language in non-Japanese speaking countries | ||
- Frustration of not being properly understood in Japanese by their own families | ||
## 3. MVP 💮 | ||
Simple concentration game with elementary Japanese [Hiragana](https://en.wikipedia.org/wiki/Hiragana) characters | ||
## 4. Target group 🧒🏾🧒🏼🧒🏿🧒🏻🧒🏽 | ||
## 3. Target group 🧒🏾🧒🏼🧒🏿🧒🏻🧒🏽 | ||
Children between 5-15 years old learning Japanese as (one of) their home language(s), as well as their parents who want to support the learning journey | ||
## 5. Core function | ||
## 4. Core function | ||
🎌 Simple concentration game with elementary Japanese characters \ | ||
🪄 Personalize game contents with your favorite Japanese characters \ | ||
📖 Add new characters you're about to learn \ | ||
🗻 Show game records you achieved \ | ||
📚 Expand your Hiragana & Katakana knowledge with additional diacritics cards \ | ||
🛝 Child friendly design \ | ||
🔎 Search Japanese character in your strongest language e.g. English or German** \ | ||
🔎 Search Japanese character in your strongest language e.g. English (or German**) \ | ||
❤️ Praise your kids for their achievements and keep cheering them (feature for parents)** \ | ||
🛝 Child friendly design \ | ||
(** upcoming features) | ||
## 6. Tech Stack | ||
## 5. Tech Stack | ||
### Backend | ||
Java, Spring Boot, Maven, REST, MongoDB, DeepL API, goo API | ||
### Frontend | ||
JavaScript, TypeScript, CSS, HTML, React, Vite, MUI | ||
### TDD | ||
### Testing / Debugging | ||
JUnit, Mockito, SonarLint, SonarCloud | ||
### DevOps, CI/CD | ||
Docker, GitHub Actions, AWS | ||
### DevOps | ||
GitHub Projects, Docker, GitHub Actions, AWS |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters