🇰🇷KoreaGuide_Server🇰🇷

This project serves as the backend of a mobile application "Forword".
The backend is developed in the form of a RESTAPI.

Forword is an abbreviation of Foreign + Word
The pronounciation of this word is similar to the English word "Forward", which means to move furthur to a certain destination

We hope that users of FORWORD could move FORWARD with their journey of learning the Korean culture, especially the language and famous places

🌃Project Introduction🌃

Problem:

• Decreasing foreign tourists visiting Korea, due to COVID-19
• Lack of true knowledge of the Korean culture and language of foreigners despite the increasing popularity of k-pop and k-drama
• No services available for foreigners to learn the Korean language in a beginner level

Our Service:

• Provides a contactless way of touring Korea
• Allows users to learn the Korean language through the introduction of famous tourist spots

📱Project Images📱

Image	Description
	Splash, Login, Register
	Home with "Word of the Day" & 3 tourist spots
	Place List & Map Customization
	Place Detail with Information & Related words
	My Word Folder & WordList
	Quiz (Type 1) Complete the spelling of word letter by letter
	Quiz(Type 2 & 3) Type2: Listen to the pronounciation & match word Type3:Enter the Korean spelling
	Quiz(Type 4) Match the meaning word
	My Profile

💻Installation and Set up💻

To begin using this template, choose one of the following options to get started:

• Fork, Clone, or Download on GitHub
• Open the project through Intellij IDEA

To set up the database with pre-defined SQL statements, please refer to the file below:

• See SQL

📝Requirements📝

• Java Version 11
• Spring Boot Version 2.4.3
• MySQL Version 8.0.23

📕Dependencies📕

    //jwt
    implementation 'io.jsonwebtoken:jjwt-api:0.10.5'
    runtime 'io.jsonwebtoken:jjwt-impl:0.10.5'
    runtime 'io.jsonwebtoken:jjwt-jackson:0.10.5'

    compile 'mysql:mysql-connector-java'
    compile 'org.projectlombok:lombok:1.18.10'
    annotationProcessor 'org.projectlombok:lombok:1.18.10'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
    compile 'org.springframework.boot:spring-boot-starter-validation'
    compile 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-security'
    

🔍Project Functions🔍

1. Duplicate check of emails
2. User Registeration
3. Login
4. Modify / Delete User information
5. Provide Today's word
6. Provide 3 randomly selected tourist place everyday
7. Create/ Update/ DeleteMy Word Folder
8. Add / Delete to My Wordlist
9. Map customization (change color of regions)
10. Read placelists (in all regions, per region)
11. Place Detail (detailed information & related words)
12. Learn words in my wordlist(READ)
13. Quiz (4Types)
14. Create / Read my Quiz Result
15. Create / Delete / Update My map (wishlist & have been to lists)

📚API Endpoints📚

User Related Endpoints

Request Type	Path	Need Token	Method	Description
POST	/api/user	NO	CREATE	Create User & save access token for user - Register (회원가입)
GET	/api/user/{id}	YES	READ	Get information of 1 particular user (사용자 정보 조회)
PATCH	/api/user/{id}	YES	UPDATE	Update information of a particular user (사용자 정보 수정)
DELETE	/api/user/{id}	YES	DELETE	Delete user (사용자 삭제)
POST	/api/user/checkDuplicate	NO	-	Check Duplicate user by email (사용자 이메일 중복 확인 - 회원가입 페이지에서 사용하면 됨)
POST	/api/user/login	NO	-	User Login(사용자 로그인)

Home Related Endpoints

Request Type	Path	Need Token	Method	Description
GET	/api/home/	YES	READ & CREATE	Get information needed in home page(홈 화면에서 필요한 정보 조회)

MyWordFolder (내 단어장 폴더) Related Endpoints

Request Type	Path	Need Token	Method	Description
POST	api/myWordFolder/	YES	CREATE	Make my word folder (내 단어장 폴더 생성)
GET	api/myWordFolder/{id}	YES	READ	Get my word folder list (내 단어장 폴더 목록 보기)
DELETE	api/myWordFolder/{id}	YES	DELETE	Delete my word folder list(내 특정 단어장 폴더 삭제)
PATCH	api/myWordFolder/{id}	YES	UPDATE	Modify my word folder name(내 특정 단어장 이름 변경)
GET	api/myWordFolder/learn/{id}?page={pageNumber}	YES	READ	Learn certain words in a particular word folder (내 특정 단어장 폴더에 있는 단어들 학습하기) - With Pagination
GET	api/myWordFolder/learnWord/{id}/{folderId}	YES	READ	Learn certain words in a particular word folder (내 특정 단어장 폴더에 있는 단어들 학습하기) - Without Pagination

MyWord (내 단어장) Related Endpoints

Request Type	Path	Need Token	Method	Description
POST	/api/myWord/{id}	YES	CREATE	Add certain word to a particular word folder(특정 단어장 폴더에 특정 단어 추가)
GET	api/myWord/{id}/{wordFolderId	YES	READ	Get all wordlist in a particular word folder(특정 단어장 폴더에 있는 단어들 정보 조회)
DELETE	/api/myWord/{id}	YES	DELETE	Delete a particular word in a word folder(특정 단어장 폴더에 있는 특정 단어 삭제)

Place Related Endpoints

Request Type	Path	Need Token	Method	Description
GET	/api/place/regionList/{id}	YES	READ	Get all region list (모든 지역에 대한 정보 조회(지역 리스트 받기))
PATCH	/api/place/regionList/{id}	YES	UPDATE	Change color of a certain region (어떤 지역의 색 바꾸기)
GET	/api/place/region/{userId}/{id}	YES	READ	Get all place list in a certain region(특정 지역에 대한 관광지 리스트 조회)

Place Detail Related Endpoints

Request Type	Path	Need Token	Method	Description
GET	/api/place/detail/{userId}/{id}	YES	READ	Get information of a certain place in both English & Korean (특정 관광지에 대한 정보 조회 (영어 & 한국어))
GET	/api/place/detail/eng/{userId}/{id}	YES	READ	Get information of a certain place in English (특정 관광지에 대한 정보 조회 (영어))
GET	/api/place/detail/kor/{userId}/{id}	YES	READ	Get information of a certain place in Korean (특정 관광지에 대한 정보 조회 (한국어))
GET	/api/place/word/{userId}/{id}?page={pageNumber}	YES	READ	Get all wordlist related to a certain place (특정 관광지의 단어 리스트) - with pagination
GET	/api/place/wordList/{userId}/{id}	YES	READ	Get all wordlist related to a certain place (특정 관광지의 단어 리스트) - without pagination

My Map Related Endpoints

Request Type	Path	Need Token	Method	Description
POST	api/myMap/{id}	YES	CREATE	Add place to my map(내 지도에 장소 넣기(wish & have been to))
GET	api/myMap/all/{id}	YES	READ	Get all place list in my map(내 지도에 포함된 모든 장소 보기(wish & have been to))
GET	api/myMap/wish/{id}	YES	READ	Get place list in my map(내 지도에 포함된 장소 보기(wish ONLY))
GET	api/myMap/haveBeen/{id}	YES	READ	Get place list in my map(내 지도에 포함된 장소 보기(have been to ONLY))
PATCH	api/myMap/{id}	YES	UPDATE	Modify place information in my map(내 지도에 있는 장소 수정)
DELETE	api/myMap/{id}	YES	DELETE	Delete place in my map(내 지도에 있는 장소 삭제)
POST	api/myMap/upload/{id}	YES	CREATE / UPDATE	Create and update json file for map customization(지도 색 부분에서 필요한 json 파일 올리기 / 업데이트)
GET	api/myMap/download/{id}	YES	READ	Get json file related to map color(지도 색 부분에서 필요한 json 파일 받기)

WORD Related Endpoints

Request Type	Path	Need Token	Method	Description
GET	api/word/{wordId}	YES	READ	Get specific information of a certain word(특정 단어에 대한 정보 조회 (HOME의 단어랑 연결시 사용))

Quiz Related Endpoints

Request Type	Path	Need Token	Method	Description
POST	api/quiz/{id}	YES	READ	Get quiz material(해당 퀴즈에 출제될 문제목록 및 객관식 목록 받아오기)
POST	api/quiz/result/{id}	YES	UPDATE	Update quiz result(퀴즈 종료 후 해당 퀴즈의 결과 서버에 업데이트)

Profile Related Endpoints

Request Type	Path	Need Token	Method	Description
GET	api/profile/{id}	YES	READ	Get information of users attendance & quiz result for this week (사용자의 1주일치 출석 & 단어 시험 결과 조회)

ERD

See SQL

📥Examples & Explanation of Basic Request & Responses📥

Example of Token in header

Basic Token header

Authorization Bearer eyJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOjExLCJuYW1lIjoiQ2luZGlhIn0.vNieUBizIAzhwpAv_J2m9GSMMUO96LTaWPLxYYOG_W8

Token for login & register & checkDuplicate (Made due to front-end request)

Authorization Bearer no_value

Response if wrong / no Token provided (헤더에 토큰 없거나 틀려서 생기는 오류)

Explanation of Pagination

    - total pages: 총 페이지
    - total elements: 페이지네이션하는 아이템의 총 수
    - current page: 현재 페이지 
    - current elements: 현재 페이지에 있는 아이템의 수 

** pageNumber은 1부터 시작! 

👩🏻‍💻Team Members & role👩🏻‍💻

• Jisoo Kim - Backend & UI design
• Chihyun Song - Front-end (Main)
• Seonho Im - External API & Data filtering & Front-end (Sub)

📆Overall Development Schedule📆

🔴 All Team Members
🟢 Jisoo Kim
🔵 Chihyun Song
🟡 Seonho Im