Skip to content

Latest commit

Β 

History

History
376 lines (263 loc) Β· 16.4 KB

README.md

File metadata and controls

376 lines (263 loc) Β· 16.4 KB
Raw


Typing SVG

HTML CSS js aws springboot


Remember done, Record on!

기얡이 μ•„λ‹Œ 기둝에 μ˜ν•œ κ²½ν—˜μ„ λ‹΄μ•„λ³΄μ„Έμš”.!
Explore the docs Β»

λͺ©μ°¨
  1. Service Introduction
  2. Functions
  3. Deployment Link
  4. User Guide
  5. ERD
  6. Commit Message Convention
  7. Branch Criteria
  8. Stack
  9. Documentation
  10. Team member
  11. Acknowledgments

Service Introduction

κ²½ν—˜μ„ μƒμ„Έν•˜κ²Œ κΈ°λ‘ν•˜κΈ° μ–΄λ €μš΄ 이듀을 μœ„ν•œ β€κ²½ν—˜ 기둝 μ„œλΉ„μŠ€, RECORD ON”

  • 🧐 λ§Žμ€ λŒ€ν•™μƒλ“€μ€ μžμ‹ μ˜ κ²½ν—˜μ„ κΈ°λ‘ν•˜λŠ” 방법을 λͺ°λΌ 기얡에 μ˜μ‘΄ν•˜κ±°λ‚˜ κ°„λ‹¨ν•˜κ²Œλ§Œ κΈ°λ‘ν•©λ‹ˆλ‹€.
  • πŸ˜” 이둜 인해, μ·¨μ—… μ€€λΉ„ λ‹¨κ³„μ—μ„œ μžκΈ°μ†Œκ°œμ„œ μž‘μ„±ν•  λ•Œ ν•„μš”ν•œ λ‚΄μš©μ„ μΆ©λΆ„νžˆ 담지 λͺ»ν•˜λŠ” 어렀움을 κ²ͺμŠ΅λ‹ˆλ‹€.

πŸ’‘ μ΄λŸ¬ν•œ 문제λ₯Ό ν•΄κ²°ν•˜κΈ° μœ„ν•΄,

  1. κ²½ν—˜μ„ μƒμ„Έν•˜κ²Œ 기둝할 수 μžˆλ„λ‘ 도와주고
  2. μžκΈ°μ†Œκ°œμ„œ μž‘μ„±μ— ν•„μš”ν•œ λ‚΄μš©μ„ 효과적으둜 μΆ”μΆœν•  수 μžˆλŠ” μ„œλΉ„μŠ€λ₯Ό μ œκ³΅ν•©λ‹ˆλ‹€.

(back to top)

Goals & Non-Goals

Goals

  • κ²½ν—˜μ˜ μƒμ„Έν•œ λΆ€λΆ„λ“€κΉŒμ§€ μ²΄κ³„μ μœΌλ‘œ 기둝할 수 μžˆλ„λ‘ λ„μ™€μ£ΌλŠ” 것.
  • μƒμ„Έν•œ 기둝을 톡해 μžκΈ°μ†Œκ°œμ„œλ₯Ό λ§‰νž˜μ—†μ΄ μž‘μ„±ν•  수 μžˆλ„λ‘ λ„μ™€μ£ΌλŠ” 것.

Non-goals

  • λ‹¨μˆœνžˆ μžκΈ°μ†Œκ°œμ„œλ₯Ό 잘 μž‘μ„±ν•˜κ²Œ μ¨μ£ΌλŠ” 것.
  • μ „λ¬Έ μžκΈ°μ†Œκ°œμ„œ ν”Όλ“œλ°±μ„ ν•΄μ£ΌλŠ” 것.

(back to top)

Functions

Record

🌿 1. νƒœκ·Έ 및 질문 κ°€μ΄λ“œλΌμΈμ„ ν†΅ν•œ κ²½ν—˜ 기둝 κΈ°λŠ₯

  • κ²½ν—˜ νƒœκ·Έμ™€ μ§ˆλ¬Έμ„ μ œκ³΅ν•˜λŠ” κΈ°λŠ₯
    • 도전, 성곡, μ‹€νŒ¨ λ“± λ‹€μ–‘ν•œ κ²½ν—˜ νƒœκ·Έμ™€ ν•΄λ‹Ή νƒœκ·Έμ— λ§žλŠ” ꡬ체적인 μ§ˆλ¬Έμ„ 톡해 κ²½ν—˜μ„ μžμ„Ένžˆ 기둝할 수 μžˆμ–΄μš”.
  • λ‹΅λ³€ 기둝 및 μž‘μ„± μ œν•œ κΈ°λŠ₯
    • μ§ˆλ¬Έμ— 닡변을 κΈ°λ‘ν•˜λ©΄ 또 λ‹€λ₯Έ νƒœκ·Έμ™€ μ§ˆλ¬Έμ„ 선택할 수 μžˆμ–΄μš”. 첫 νƒœκ·Έμ™€ μ§ˆλ¬Έμ— λ‹΅ν•˜μ§€ μ•Šκ³  β€˜μžμœ λž€β€™λ§Œ μž‘μ„±ν•˜λ©΄ 기둝 μ™„λ£Œ λ²„νŠΌμ΄ λΉ„ν™œμ„±ν™”λΌμš”.
  • κ²½ν—˜ 기둝 μ €μž₯ 및 관리 κΈ°λŠ₯
    • μž‘μ„±ν•œ κ²½ν—˜ 기둝은 μ €μž₯되고, κ²½ν—˜κΈ°λ‘ νŽ˜μ΄μ§€μ—μ„œ λͺ¨λ“  기둝을 ν•œλˆˆμ— λͺ¨μ•„λ³Ό 수 μžˆμ–΄μš”. 이λ₯Ό 톡해 μžμ†Œμ„œ μž‘μ„±μ— ν•„μš”ν•œ 자료λ₯Ό μ‰½κ²Œ 찾을 수 μžˆμ–΄μš”.

View

🌿 2. 기둝듀을 μΉ΄λ“œ ν˜•μ‹μœΌλ‘œ λͺ¨μ•„λ³Ό 수 μžˆλŠ” κΈ°λŠ₯

  • ν”„λ‘œμ νŠΈ 생성 κΈ°λŠ₯
    • ν”„λ‘œμ νŠΈ 이름, ν•œ 쀄 μ†Œκ°œ, 진행 κΈ°κ°„, μ—­ν• , 선택 이유λ₯Ό μž‘μ„±ν•˜λ©΄ ν”„λ‘œμ νŠΈκ°€ μƒμ„±λΌμš”. (*사진 μ²¨λΆ€λŠ” 선택)
  • ν”„λ‘œμ νŠΈ μΉ΄λ“œ λͺ¨μŒ κΈ°λŠ₯
    • ν”„λ‘œμ νŠΈ μΉ΄λ“œμ—λŠ” ν”„λ‘œμ νŠΈλͺ…, 진행 κΈ°κ°„, 핡심 μ—­λŸ‰ νƒœκ·Έκ°€ ν¬ν•¨λ˜λ©°, 전체 μΉ΄λ“œλ“€μ„ λͺ¨μ•„λ³Ό 수 μžˆλŠ” νŽ˜μ΄μ§€κ°€ μžˆμ–΄μš”.
  • ν”„λ‘œμ νŠΈ λ‚΄ κ²½ν—˜κΈ°λ‘ μΉ΄λ“œ λͺ¨μŒ κΈ°λŠ₯
    • κ²½ν—˜ 기둝 μΉ΄λ“œμ—λŠ” μ†Œμ œλͺ©, κ²½ν—˜ν•œ λ‚ μ§œ, κ²½ν—˜ νƒœκ·Έκ°€ ν¬ν•¨λ˜λ©°, ν”„λ‘œμ νŠΈ μΉ΄λ“œ λ‚΄μ—μ„œ κ²½ν—˜κΈ°λ‘ μΉ΄λ“œλ₯Ό μƒμ„±ν•˜κ³  λͺ¨μ•„λ³Ό 수 μžˆμ–΄μš”.
  • κ²½ν—˜κΈ°λ‘ μž‘μ„± κΈ°λŠ₯
    • μ†Œμ œλͺ©, κ²½ν—˜ν•œ λ‚ μ§œ, κ²½ν—˜ νƒœκ·Έ 및 μ§ˆλ¬Έμ— λŒ€ν•œ 닡변을 μž‘μ„±ν•  수 μžˆμ–΄μš”.

Filtering

🌿 3. νƒœκ·Έ 필터링 및 단어 검색 κΈ°λŠ₯

  • 핡심 μ—­λŸ‰ νƒœκ·Έ 및 κ²½ν—˜ νƒœκ·Έ 필터링 κΈ°λŠ₯κ³Ό 단어 검색 κΈ°λŠ₯을 톡해 λΉ λ₯΄κ³  μ‰½κ²Œ ν•„μš”ν•œ 기둝을 찾을 수 μžˆμ–΄μš”!

(back to top)

Deployment Link

(back to top)

User Guide

1. λžœλ”© νŽ˜μ΄μ§€

  • κ°€μž₯ κΈ°λ³Έ νŽ˜μ΄μ§€λ‘œ, μ„œλΉ„μŠ€μ— λŒ€ν•œ μ„€λͺ…이 μ ν˜€ μžˆμŠ΅λ‹ˆλ‹€.
  • κ²½ν—˜ 기둝 μ‹œμž‘ λ²„νŠΌμ„ 클릭 μ‹œ ꡬ글 둜그인 후에
    • 처음 μ„œλΉ„μŠ€λ₯Ό μ‚¬μš©ν•  경우 νšŒμ›κ°€μž… νŽ˜μ΄μ§€λ‘œ λ„˜μ–΄κ°‘λ‹ˆλ‹€.
    • 전에 μ„œλΉ„μŠ€λ₯Ό μ‚¬μš©ν•΄ λ³Έ κ²½ν—˜μ΄ μžˆλŠ” 경우 μ‚¬μš©μžμ˜ ν”„λ‘œμ νŠΈ μΉ΄λ“œ λͺ¨μŒ νŽ˜μ΄μ§€λ‘œ λ„˜μ–΄κ°‘λ‹ˆλ‹€.

1-2. νšŒμ›κ°€μž… νŽ˜μ΄μ§€

  • 처음 μ„œλΉ„μŠ€λ₯Ό μ‚¬μš©ν•  경우 둜그인 ν›„ λ„˜μ–΄κ°€λŠ” νŽ˜μ΄μ§€λ‘œ, μ‚¬μš©μžμ˜ 이름과 희망 직ꡰ을 선택할 수 있으며, μ‚¬μš©μž μ•½κ΄€ 정보가 담겨 μžˆμŠ΅λ‹ˆλ‹€.

2. ν”„λ‘œμ νŠΈ μΉ΄λ“œ λͺ¨μŒ νŽ˜μ΄μ§€

  • μ‚¬μš©μžκ°€ 둜그인 후에 처음으둜 보게 λ˜λŠ” νŽ˜μ΄μ§€λ‘œ, 이전에 μ§„ν–‰ν•˜λ˜ ν”„λ‘œμ νŠΈλ₯Ό λ³Ό μˆ˜λ„ 있고, μƒˆλ‘œμš΄ ν”„λ‘œμ νŠΈλ₯Ό λ§Œλ“€ μˆ˜λ„ μžˆμŠ΅λ‹ˆλ‹€.
  • μ—­λŸ‰ νƒœκ·Έλ₯Ό μ„ νƒν•˜μ—¬ μ™„λ£Œλœ ν”„λ‘œμ νŠΈ 쀑에 ν•΄λ‹Ή νƒœκ·Έκ°€ κ±Έλ € μžˆλŠ” ν”„λ‘œμ νŠΈλ“€μ„ 검색할 수 μžˆμŠ΅λ‹ˆλ‹€.
  • κΈ°κ°„ μ„€μ •μœΌλ‘œ ν•΄λ‹Ή κΈ°κ°„λ™μ•ˆ μ§„ν–‰λœ ν”„λ‘œμ νŠΈλ₯Ό κ²€μƒ‰ν•˜μ—¬ λ³Ό 수 μžˆμŠ΅λ‹ˆλ‹€.
  • 진행 ν˜„ν™©μ„ μ„ νƒν•˜μ—¬ μ§„ν–‰μ€‘μ΄κ±°λ‚˜ 진행 μ™„λ£Œλœ ν”„λ‘œμ νŠΈλ§Œ κ²€μƒ‰ν•˜μ—¬ λ³Ό 수 μžˆμŠ΅λ‹ˆλ‹€.

2-2. ν”„λ‘œμ νŠΈ 생성 νŽ˜μ΄μ§€

  • ν”„λ‘œμ νŠΈ κ°€λ“œ λͺ¨μŒ νŽ˜μ΄μ§€μ—μ„œ ν”„λ‘œμ νŠΈ μΆ”κ°€ λ²„νŠΌμ„ λˆ„λ₯Ό μ‹œ λ³Ό 수 μžˆλŠ” νŽ˜μ΄μ§€λ‘œ λ‹€μ–‘ν•œ 정보λ₯Ό κΈ°μž…ν•˜κ³  μƒˆλ‘œμš΄ ν”„λ‘œμ νŠΈλ₯Ό 생성할 수 μžˆμŠ΅λ‹ˆλ‹€.

3. κ²½ν—˜κΈ°λ‘ μΉ΄λ“œ λͺ¨μŒ νŽ˜μ΄μ§€

  • ν”„λ‘œμ νŠΈ κ°€λ“œ λͺ¨μŒ νŽ˜μ΄μ§€μ—μ„œ ν”„λ‘œμ νŠΈλ₯Ό 선택 μ‹œ λ³Ό 수 μžˆλŠ” νŽ˜μ΄μ§€μž…λ‹ˆλ‹€.
  • κΈ°λŠ₯)
    • μ‚¬μš©μžκ°€ μž‘μ„±ν–ˆλ˜ κ²½ν—˜ 기둝듀을 μ—΄λžŒν•  수 μžˆμŠ΅λ‹ˆλ‹€.
    • κ΄€λ ¨ 자료 링크 λ²„νŠΌμ„ 클릭 μ‹œ μ‚¬μš©μžκ°€ κΈ°λ‘ν–ˆλ˜ 링크듀을 λͺ¨μ•„λ³Ό 수 μžˆμŠ΅λ‹ˆλ‹€.
    • κ²½ν—˜ 기둝 μΆ”κ°€ λ²„νŠΌμ„ 눌러 μƒˆλ‘œμš΄ κ²½ν—˜μ„ 기둝할 수 μžˆμŠ΅λ‹ˆλ‹€.
    • ν”„λ‘œμ νŠΈ μ™„λ£Œν•˜κΈ° λ²„νŠΌμ„ 눌러 ν•΄λ‹Ή ν”„λ‘œμ νŠΈλ₯Ό μ™„λ£Œμ‹œν‚¬ 수 μžˆμŠ΅λ‹ˆλ‹€.

  • κ²½ν—˜ νƒœκ·Έλ₯Ό μ„ νƒν•˜μ—¬ μž‘μ„±ν•œ κ²½ν—˜ 쀑에 ν•΄λ‹Ή νƒœκ·Έκ°€ κ±Έλ € μžˆλŠ” κ²½ν—˜λ“€μ„ 검색할 수 μžˆμŠ΅λ‹ˆλ‹€.
  • κΈ°κ°„ μ„€μ •μœΌλ‘œ ν•΄λ‹Ή κΈ°κ°„λ™μ•ˆ μ§„ν–‰λœ κ²½ν—˜λ“€μ„ κ²€μƒ‰ν•˜μ—¬ λ³Ό 수 μžˆμŠ΅λ‹ˆλ‹€.
  • 단어λ₯Ό κΈ°μž…ν•˜μ—¬ ν•΄λ‹Ή 단어가 λ“€μ–΄κ°„ κ²½ν—˜λ“€μ„ λͺ¨μ•„ 검색할 수 μžˆμŠ΅λ‹ˆλ‹€.

3-2. κ΄€λ ¨ 자료 링크 νŽ˜μ΄μ§€

  • κ²½ν—˜κΈ°λ‘ μΉ΄λ“œ λͺ¨μŒ νŽ˜μ΄μ§€μ—μ„œ κ΄€λ ¨ 자료 링크 λ²„νŠΌμ„ 클릭 μ‹œ λ³Ό 수 μžˆλŠ” νŽ˜μ΄μ§€μž…λ‹ˆλ‹€.
  • κ²½ν—˜μ„ κΈ°λ‘ν•˜λ©΄μ„œ μ²¨λΆ€ν–ˆλ˜ 링크듀을 μ „λΆ€ λͺ¨μ•„ λ³Ό 수 μžˆμŠ΅λ‹ˆλ‹€.

3-3. ν”„λ‘œμ νŠΈ μ™„λ£Œν•˜κΈ° νŽ˜μ΄μ§€

  • κ²½ν—˜κΈ°λ‘ μΉ΄λ“œ λͺ¨μŒ νŽ˜μ΄μ§€μ—μ„œ ν”„λ‘œμ νŠΈ μ™„λ£Œν•˜κΈ° λ²„νŠΌμ„ 클릭 μ‹œ λ³Ό 수 μžˆλŠ” νŽ˜μ΄μ§€μž…λ‹ˆλ‹€.
  • μ‚¬μš©μžκ°€ ν”„λ‘œμ νŠΈμ— κ±Έ νƒœκ·Έλ₯Ό μ΅œλŒ€ μ„Έ 개 선택할 수 있으며 μ„ νƒν•œ νƒœκ·ΈλŠ” ν”„λ‘œμ νŠΈ μΉ΄λ“œ λͺ¨μŒ νŽ˜μ΄μ§€μ—μ„œ 확인할 수 μžˆμŠ΅λ‹ˆλ‹€.

4. κ²½ν—˜κΈ°λ‘ μΉ΄λ“œ 생성

  • κ²½ν—˜κΈ°λ‘ μΉ΄λ“œ λͺ¨μŒ νŽ˜μ΄μ§€μ—μ„œ κ²½ν—˜ 기둝 μΆ”κ°€ λ²„νŠΌμ„ 클릭 μ‹œ λ³Ό 수 μžˆλŠ” νŽ˜μ΄μ§€μž…λ‹ˆλ‹€.
  • μ—¬λŸ¬ 정보λ₯Ό κΈ°μž…ν•  수 μžˆμŠ΅λ‹ˆλ‹€.

  • κ²½ν—˜ νƒœκ·Έλ₯Ό ν΄λ¦­ν•˜μ—¬ μ§ˆλ¬Έμ„ μ„ νƒν•˜κ³  ν•΄λ‹Ή μ§ˆλ¬Έμ— λŒ€ν•œ 닡변을 κΈ°μž…ν•  수 μžˆμŠ΅λ‹ˆλ‹€.

  • 자유둭게 λͺ» λ‹€ν•œ 이야기λ₯Ό μž‘μ„±ν•˜κ±°λ‚˜, ν•΄λ‹Ή κ²½ν—˜μ„ κ²ͺ은 날에 μ‚¬μš©ν•œ λ‹€λ₯Έ νˆ΄λ“€μ˜ 링크λ₯Ό 첨뢀할 μˆ˜λ„ μžˆμŠ΅λ‹ˆλ‹€.

(back to top)

ERD

(back to top)

Commit Message Convention

 < form >
{ν•œλ‹€} {무엇을} {μ–΄λ–»κ²Œ}
{μ„ΈλΆ€ λ‚΄μš© μ„€λͺ…}

 < ex >
:sparkles: Add login pages
:bug: Fix CORS Error

πŸš€ - Deploy stuff `:rocket:`

⚑ - Improve performance `:zap:`

πŸ”₯ - Remove code or files `:fire:`

πŸ› - Fix a bug `:bug:`

✨ - Introduce new features `:sparkles:`

βœ… - Add, Update `:white_check_mark:`

πŸ“ - Add or update documentation `:memo:`

πŸ™ˆ - Add or update ignore `:see_no_evil:`

(back to top)

Branch Criteria

(back to top)

Stack

🌟 Frontend (Web)

Language : JavaScript
Library & Framework : React, Styled-Components, Axios, Recoil
Deploy: Firebase

πŸ’» Backend

Language : Java
Library & Framework : Spring Boot
Database : MySQLDB
ORM : JPA
Deploy: Mysql(Storage)
Infrastructure : AWS EC2, AWS S3, AWS IAM, AWS Route 53, AWS VPC

(back to top)

Documentation

(back to top)

Team Member

🐣 μ‘°μ˜ˆμ€ 🐭 λ°•μ˜ˆλžŒ πŸ¦‰ κΉ€κΈ°μ˜ 🦊 μ „μ†Œλͺ…
PM 기획 λ°±μ—”λ“œ λ°±μ—”λ“œ
🐰 μ΄μœ€μ„œ 🐹 κΉ€μ˜ˆμ€ 🐨 λ°•μ£Όμ˜ 🐢 이민규
λ””μžμΈ ν”„λ‘ νŠΈμ—”λ“œ ν”„λ‘ νŠΈμ—”λ“œ ν”„λ‘ νŠΈμ—”λ“œ

(back to top)

Acknowledgments

(back to top)