๋๊ตฌ๋ ์ง๋ฌธํ๊ณ , ์์งํ๊ฒ ๋ตํ๋ ์คํ๋ง์ธ๋ ์ปค๋ฎค๋ํฐ ์๋น์ค
'์ด๋ ค๋ผ ์ฐธ๊นจ'๋ ์ฌ์ฉ์๊ฐ ํผ๋๋ฅผ ์์ฑํ๊ณ , ๋ค๋ฅธ ์ฌ์ฉ์๋ค๋ก๋ถํฐ ์ง๋ฌธ์ ๋ฐ์ผ๋ฉฐ ์ํตํ ์ ์๋ ํ๋ซํผ์ ๋๋ค. ์ต๋ช ํน์ ๊ธฐ๋ช ์ผ๋ก ๋ง์์ ์ด๊ณ ๋ํํ๋ ๊ณต๊ฐ์ ์งํฅํฉ๋๋ค.
- ๐ ํผ๋ ์์ฑ: ์ด๋ฆ์ ์ ๋ ฅํ์ฌ ๋๋ง์ ์ง๋ฌธ ํผ๋ ์์ฑ
- ๐ฌ ์ง๋ฌธํ๊ธฐ: ๋ค๋ฅธ ์ฌ์ฉ์์๊ฒ ์ต๋ช ์ผ๋ก ์ง๋ฌธ ์์ฑ
- โ๏ธ ๋ต๋ณ ๊ด๋ฆฌ: ๋ฐ์ ์ง๋ฌธ์ ๋ต๋ณ ์์ฑ/์์ /์ญ์
- ๐ ๋ฐ์ํ๊ธฐ: ๋ต๋ณ์ ์ข์์ ๋ฐ์
- ๐ ๊ณต์ ํ๊ธฐ: ์นด์นด์คํก, ํ์ด์ค๋ถ, ๋งํฌ ๋ณต์ฌ๋ก ํผ๋ ๊ณต์
- ๐ฑ ๋ฐ์ํ ๋์์ธ: ๋ชจ๋ฐ์ผ, ํ๋ธ๋ฆฟ, ๋ฐ์คํฌํฑ ์ต์ ํ
- 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
- Code Quality: ESLint, Prettier
- Version Control: Git, GitHub
- Design System: Figma
- 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 | ๋ต๋ณ ์์ฑ/์์ /์ญ์ (๊ด๋ฆฌ์ ํ์ด์ง) |
- Node.js 18.x ์ด์
- npm ๋๋ yarn
# ์ ์ฅ์ ํด๋ก
git clone https://github.com/Choiyuhyeon/Open-Sesame.git
cd Open-Sesame
# ์์กด์ฑ ์ค์น
npm install
# ๊ฐ๋ฐ ์๋ฒ ์คํ
npm run devnpm run dev # ๊ฐ๋ฐ ์๋ฒ ์คํ (http://localhost:5173)
npm run build # ํ๋ก๋์
๋น๋
npm run preview # ๋น๋ ๊ฒฐ๊ณผ ๋ฏธ๋ฆฌ๋ณด๊ธฐ
npm run lint # ESLint ๊ฒ์ฌ
npm run lint:fix # ESLint ์๋ ์์
npm run format # Prettier ํฌ๋งทํ
| Type | Description |
|---|---|
feat |
์๋ก์ด ๊ธฐ๋ฅ ์ถ๊ฐ |
fix |
๋ฒ๊ทธ ์์ |
refactor |
์ฝ๋ ๋ฆฌํฉํ ๋ง |
style |
์ฝ๋ ํฌ๋งทํ , ์ธ๋ฏธ์ฝ๋ก ๋๋ฝ ๋ฑ |
docs |
๋ฌธ์ ์์ |
test |
ํ ์คํธ ์ฝ๋ ์ถ๊ฐ |
chore |
๋น๋ ๊ณผ์ ๋๋ ๋ณด์กฐ ๋๊ตฌ ๋ณ๊ฒฝ |
This project is licensed under the MIT License - see the LICENSE file for details.