Skip to content

Choiyuhyeon/Open-Sesame

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

195 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ”‘ ์—ด๋ ค๋ผ ์ฐธ๊นจ, Open Sesame

๋ˆ„๊ตฌ๋‚˜ ์งˆ๋ฌธํ•˜๊ณ , ์†”์งํ•˜๊ฒŒ ๋‹ตํ•˜๋Š” ์˜คํ”ˆ๋งˆ์ธ๋“œ ์ปค๋ฎค๋‹ˆํ‹ฐ ์„œ๋น„์Šค


๐Ÿ“– ํ”„๋กœ์ ํŠธ ์†Œ๊ฐœ

'์—ด๋ ค๋ผ ์ฐธ๊นจ'๋Š” ์‚ฌ์šฉ์ž๊ฐ€ ํ”ผ๋“œ๋ฅผ ์ƒ์„ฑํ•˜๊ณ , ๋‹ค๋ฅธ ์‚ฌ์šฉ์ž๋“ค๋กœ๋ถ€ํ„ฐ ์งˆ๋ฌธ์„ ๋ฐ›์œผ๋ฉฐ ์†Œํ†ตํ•  ์ˆ˜ ์žˆ๋Š” ํ”Œ๋žซํผ์ž…๋‹ˆ๋‹ค. ์ต๋ช… ํ˜น์€ ๊ธฐ๋ช…์œผ๋กœ ๋งˆ์Œ์„ ์—ด๊ณ  ๋Œ€ํ™”ํ•˜๋Š” ๊ณต๊ฐ„์„ ์ง€ํ–ฅํ•ฉ๋‹ˆ๋‹ค.

โœจ ์ฃผ์š” ๊ธฐ๋Šฅ

  • ๐Ÿ™‹ ํ”ผ๋“œ ์ƒ์„ฑ: ์ด๋ฆ„์„ ์ž…๋ ฅํ•˜์—ฌ ๋‚˜๋งŒ์˜ ์งˆ๋ฌธ ํ”ผ๋“œ ์ƒ์„ฑ
  • ๐Ÿ’ฌ ์งˆ๋ฌธํ•˜๊ธฐ: ๋‹ค๋ฅธ ์‚ฌ์šฉ์ž์—๊ฒŒ ์ต๋ช…์œผ๋กœ ์งˆ๋ฌธ ์ž‘์„ฑ
  • โœ๏ธ ๋‹ต๋ณ€ ๊ด€๋ฆฌ: ๋ฐ›์€ ์งˆ๋ฌธ์— ๋‹ต๋ณ€ ์ž‘์„ฑ/์ˆ˜์ •/์‚ญ์ œ
  • ๐Ÿ‘ ๋ฐ˜์‘ํ•˜๊ธฐ: ๋‹ต๋ณ€์— ์ข‹์•„์š” ๋ฐ˜์‘
  • ๐Ÿ”— ๊ณต์œ ํ•˜๊ธฐ: ์นด์นด์˜คํ†ก, ํŽ˜์ด์Šค๋ถ, ๋งํฌ ๋ณต์‚ฌ๋กœ ํ”ผ๋“œ ๊ณต์œ 
  • ๐Ÿ“ฑ ๋ฐ˜์‘ํ˜• ๋””์ž์ธ: ๋ชจ๋ฐ”์ผ, ํƒœ๋ธ”๋ฆฟ, ๋ฐ์Šคํฌํ†ฑ ์ตœ์ ํ™”

๐Ÿ›  ๊ธฐ์ˆ  ์Šคํƒ

Frontend

  • Library: React 19.2.0
  • Build Tool: Vite 7.3.1
  • Routing: React Router DOM 7.13.1
  • Styling: CSS Modules, CSS Variables
  • HTTP Client: Axios 1.13.6

Development Tools

  • Code Quality: ESLint, Prettier
  • Version Control: Git, GitHub
  • Design System: Figma

Collaboration

  • Communication: ZEP, Discord
  • Documentation: Notion
  • Project Management: GitHub Projects

๐Ÿ“ ํ”„๋กœ์ ํŠธ ๊ตฌ์กฐ

Open-Sesame/
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ components/
โ”‚   โ”‚   โ”œโ”€โ”€ common/
โ”‚   โ”‚   โ”œโ”€โ”€ home/
โ”‚   โ”‚   โ”œโ”€โ”€ list/
โ”‚   โ”‚   โ”œโ”€โ”€ post/
โ”‚   โ”‚   โ””โ”€โ”€ answer/
โ”‚   โ”œโ”€โ”€ pages/
โ”‚   โ”‚   โ”œโ”€โ”€ HomePage/
โ”‚   โ”‚   โ”œโ”€โ”€ ListPage/
โ”‚   โ”‚   โ”œโ”€โ”€ PostPage/
โ”‚   โ”‚   โ””โ”€โ”€ AnswerPage/
โ”‚   โ”œโ”€โ”€ hooks/
โ”‚   โ”œโ”€โ”€ api/
โ”‚   โ”œโ”€โ”€ styles/
โ”‚   โ”‚   โ”œโ”€โ”€ color.js
โ”‚   โ”‚   โ””โ”€โ”€ typography.js
โ”‚   โ”œโ”€โ”€ utils/
โ”‚   โ”œโ”€โ”€ assets/
โ”‚   โ””โ”€โ”€ global.css
โ”œโ”€โ”€ vite.config.js
โ””โ”€โ”€ package.json

๐Ÿ›ฃ ๋ผ์šฐํŒ… ๊ตฌ์กฐ

๊ฒฝ๋กœ ํŽ˜์ด์ง€ ์„ค๋ช…
/ HomePage ์ด๋ฆ„ ์ž…๋ ฅ ๋ฐ ํ”ผ๋“œ ์ƒ์„ฑ
/list ListPage ์งˆ๋ฌธ ํ”ผ๋“œ ๋ชฉ๋ก ์กฐํšŒ (์ •๋ ฌ, ํŽ˜์ด์ง€๋„ค์ด์…˜)
/post/:id PostPage ํŠน์ • ํ”ผ๋“œ ์งˆ๋ฌธ ์กฐํšŒ, ์ข‹์•„์š”/์‹ซ์–ด์š”, ๊ณต์œ 
/post/:id/answer AnswerPage ๋‹ต๋ณ€ ์ž‘์„ฑ/์ˆ˜์ •/์‚ญ์ œ (๊ด€๋ฆฌ์ž ํŽ˜์ด์ง€)

๐Ÿš€ ์‹œ์ž‘ํ•˜๊ธฐ

Prerequisites

  • Node.js 18.x ์ด์ƒ
  • npm ๋˜๋Š” yarn

Installation

# ์ €์žฅ์†Œ ํด๋ก 
git clone https://github.com/Choiyuhyeon/Open-Sesame.git
cd Open-Sesame

# ์˜์กด์„ฑ ์„ค์น˜
npm install

# ๊ฐœ๋ฐœ ์„œ๋ฒ„ ์‹คํ–‰
npm run dev

Available Scripts

npm run dev       # ๊ฐœ๋ฐœ ์„œ๋ฒ„ ์‹คํ–‰ (http://localhost:5173)
npm run build     # ํ”„๋กœ๋•์…˜ ๋นŒ๋“œ
npm run preview   # ๋นŒ๋“œ ๊ฒฐ๊ณผ ๋ฏธ๋ฆฌ๋ณด๊ธฐ
npm run lint      # ESLint ๊ฒ€์‚ฌ
npm run lint:fix  # ESLint ์ž๋™ ์ˆ˜์ •
npm run format    # Prettier ํฌ๋งทํŒ…

๐Ÿ‘ฅ ํŒ€์› ๋ฐ ์—ญํ• 


์ตœ์œ ํ˜„
ํŒ€ ๋ฆฌ๋”
๋‹ต๋ณ€ ํŽ˜์ด์ง€ ๊ตฌํ˜„

์ด์ˆ˜์ง„
๋””์ž์ธ ์ด๊ด„
๋‹ต๋ณ€ ๋ชฉ๋ก ํŽ˜์ด์ง€

๊น€๋„์šฑ
ํ”„๋กœ์ ํŠธ ์„ธํŒ…
๋‹ต๋ณ€ ๋ชฉ๋ก ํŽ˜์ด์ง€

์„œ์œค์ˆ˜
๋‹ต๋ณ€ ํŽ˜์ด์ง€ ๊ตฌํ˜„

์ด์ฐจํ˜„
ํ”„๋กœ์ ํŠธ ๊ตฌ์กฐ ์„ค์ •
๊ณตํ†ต ์ปดํฌ๋„ŒํŠธ

์ตœ๋ฌธ๊ฒฝ
๋ฉ”์ธ ํŽ˜์ด์ง€ ๊ตฌํ˜„

๐Ÿ“ ์ฝ”๋”ฉ ์ปจ๋ฒค์…˜

Commit Convention

Type Description
feat ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ ์ถ”๊ฐ€
fix ๋ฒ„๊ทธ ์ˆ˜์ •
refactor ์ฝ”๋“œ ๋ฆฌํŒฉํ† ๋ง
style ์ฝ”๋“œ ํฌ๋งทํŒ…, ์„ธ๋ฏธ์ฝœ๋ก  ๋ˆ„๋ฝ ๋“ฑ
docs ๋ฌธ์„œ ์ˆ˜์ •
test ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€
chore ๋นŒ๋“œ ๊ณผ์ • ๋˜๋Š” ๋ณด์กฐ ๋„๊ตฌ ๋ณ€๊ฒฝ

๐Ÿ“„ ๋ผ์ด์„ ์Šค

This project is licensed under the MIT License - see the LICENSE file for details.


About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors