Skip to content

Commit 83cec0f

Browse files
authored
Merge pull request #116 from part3-4team-Taskify/ozen0718-patch-1-1
Update README.md
2 parents 1290d69 + 3477bef commit 83cec0f

File tree

1 file changed

+92
-25
lines changed

1 file changed

+92
-25
lines changed

README.md

Lines changed: 92 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,107 @@
1-
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/pages/api-reference/create-next-app).
1+
<div style="text-align: center;">
2+
<a href="https://taskify-theta-seven.vercel.app/">
3+
<img alt="Taskify" src='/public/images/landing_hero' width="300" height="300">
4+
</a>
5+
</div>
26

3-
## Getting Started
7+
- Taskify 일정관리
8+
- 개발 기간 : 25.03.18 ~ 25.03.03
49

5-
First, run the development server:
10+
# Team
611

7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
15-
```
1612

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
13+
## 황혜진
14+
15+
- 팀장님!
16+
- 담당하신 내역 써주시면 수정하겟습니다.
17+
18+
## 김교연
19+
20+
-
21+
22+
## 임용균
23+
24+
25+
-
26+
27+
## 조민지
28+
29+
-
30+
31+
## 정종
32+
33+
-
34+
35+
# Images
36+
37+
//이미지 나중에 GIF 추가 부탁드립니다.
38+
39+
# Skill Stacks
40+
41+
## Environment
42+
43+
44+
45+
<img alt="Git" src ="https://img.shields.io/badge/Git-f05032.svg?&style=for-the-badge&logo=Git&logoColor=white"/> <img alt="GitHub" src ="https://img.shields.io/badge/GitHub-181717.svg?&style=for-the-badge&logo=GitHub&logoColor=white"/> <img alt="VSCode" src ="https://img.shields.io/badge/VSCode-007acc.svg?&style=for-the-badge&logo=visualstudiocode&logoColor=white"/> <img alt="Vercel" src ="https://img.shields.io/badge/Vercel-000000.svg?&style=for-the-badge&logo=Vercel&logoColor=white"/> <img alt="Figma" src ="https://img.shields.io/badge/Figma-f24e1e.svg?&style=for-the-badge&logo=Figma&logoColor=white"/>
46+
1847

19-
You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
2048

21-
[API routes](https://nextjs.org/docs/pages/building-your-application/routing/api-routes) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
49+
## Development
2250

23-
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/pages/building-your-application/routing/api-routes) instead of React pages.
2451

25-
This project uses [`next/font`](https://nextjs.org/docs/pages/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
2652

27-
## Learn More
53+
<img alt="Tailwind CSS" src ="https://img.shields.io/badge/Tailwind_CSS-06B6D4.svg?&style=for-the-badge&logo=tailwindcss&logoColor=white"/> <img alt="TypeScript" src ="https://img.shields.io/badge/TypeScript-3178C6.svg?&style=for-the-badge&logo=TypeScript&logoColor=white"/> <img alt="Next.js" src ="https://img.shields.io/badge/Next.js-000000.svg?&style=for-the-badge&logo=Next.js&logoColor=white"/>
2854

29-
To learn more about Next.js, take a look at the following resources:
55+
## Libraries
3056

31-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
32-
- [Learn Next.js](https://nextjs.org/learn-pages-router) - an interactive Next.js tutorial.
57+
<img alt="Axios" src ="https://img.shields.io/badge/Axios-5429e4.svg?&logo=Axios&logoColor=white&style=for-the-badge"/>
58+
<img alt="clsx" src ="https://img.shields.io/badge/clsx-CB3837.svg?&style=for-the-badge"/>
59+
<img alt="tailwind-scrollbar-hide" src ="https://img.shields.io/badge/tailwind_scrollbar_hide-06B6D4.svg?&style=for-the-badge"/>
3360

34-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
3561

36-
## Deploy on Vercel
62+
# Package Structure
3763

38-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
3964

40-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/pages/building-your-application/deploying) for more details.
65+
```
66+
taskify
67+
├─ public
68+
│ ├─ svgs # 아이콘 리소스
69+
│ └─ images # 이미지 리소스
70+
├─ src
71+
│ ├─ api # API 사용을 위한 세팅
72+
│ ├─ components # 주요 컴포넌트
73+
│ ├─ constants #
74+
│ ├─ hocks # 인증, 모달 컨텍스트 프로바이더
75+
│ ├─ pages # 커스텀 훅
76+
│ ├─ shared #
77+
| ├─ store #
78+
├─ styles
79+
│ └─ globals.css # 폰트
80+
└─ types # 스타일
81+
```
82+
83+
# Installation
84+
85+
1. Clone the repository
86+
87+
```bash
88+
git clone https://github.com/part3-4team-Taskify
89+
```
90+
91+
2. Install dependencies
92+
93+
```bash
94+
npm install
95+
```
96+
97+
3. Start the development server
98+
99+
```bash
100+
npm start dev
101+
```
102+
103+
4. Open the project in your browser
104+
105+
```bash
106+
http://localhost:3000
107+
```

0 commit comments

Comments
 (0)