Skip to content

Commit b5aa639

Browse files
committed
[Docs] 프로젝트 초기 설정작업이 추가됨에 따라 README 수정
- 프로젝트 아키텍처 관련 설명 추가
1 parent 9a225cc commit b5aa639

File tree

2 files changed

+62
-168
lines changed

2 files changed

+62
-168
lines changed

README.md

Lines changed: 62 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,67 @@
1-
21
# **Archi Semtle Web Dev** (FE)
32

43
## 📝 **프로젝트 소개**
5-
...
6-
74

8-
9-
## 🚀 **주요 기능**
105
...
116

7+
## 🚀 **주요 기능**
128

9+
...
1310

1411
## 📂 **프로젝트 구조**
12+
1513
```plaintext
1614
/
15+
├── .vscode/ # VSCode 환경 설정
16+
│ ├── settings.json # VSCode 특정 프로젝트 설정 (예: 포맷터, 들여쓰기 등)
17+
|
1718
├── documents/ # README 모음
1819
├── public/ # 정적 파일 (이미지, 폰트 등)
1920
├── src/ # 소스 코드
2021
│ ├── app/ # Next.js App Router 관련 파일
21-
│ │ ├── fonts/ # 웹폰트 관련 파일
22-
│ │ ├── favicon.ico # 파비콘 파일
23-
│ │ ├── globals.css # 전역 스타일링
24-
│ │ ├── layout.tsx # 레이아웃 컴포넌트
25-
│ │ └── page.tsx # 루트 페이지 컴포넌트
26-
│ ├── components/ # 재사용 가능한 컴포넌트
27-
│ ├── pages/ # (선택) 기존 Next.js Pages 라우팅 (사용 시)
28-
│ ├── styles/ # CSS 및 스타일링 관련 파일
29-
│ ├── utils/ # 유틸리티 함수 및 공통 로직
22+
│ │ ├── about/ # "소개" 페이지
23+
│ │ │ ├── page.tsx # /about 경로의 컴포넌트
24+
│ │ ├── activities/ # "활동" 페이지
25+
│ │ ├── executive/ # "집행부" 페이지
26+
│ │ ├── history/ # "History" 페이지
27+
│ │ ├── login/ # 로그인 페이지
28+
│ │ ├── mypage/ # "마이페이지" 디렉토리
29+
│ │ ├── organization/ # "조직도" 페이지
30+
│ │ ├── projects/ # 프로젝트 관련 디렉토리
31+
│ │ │ ├── page.tsx # /projects 경로의 메인 페이지
32+
│ │ │ ├── completed/ # 완료된 프로젝트 관련 디렉토리
33+
│ │ │ │ ├── [projectID]/ # 동적 경로: 특정 완료된 프로젝트 상세 페이지
34+
│ │ │ │ ├── page.tsx # /projects/completed/:projectID
35+
│ │ │ ├── recruit/ # 프로젝트 모집 관련 디렉토리
36+
│ │ │ ├── [projectID]/ # 동적 경로: 특정 모집 프로젝트 상세 페이지
37+
│ │ │ ├── page.tsx # /projects/recruit/:projectID
38+
│ │ ├── recruiting/ # "가입안내" 페이지
39+
│ │ ├── regulations/ # "학회회칙" 페이지
40+
│ │ ├── schedule/ # "학회일정" 페이지
41+
│ │ ├── secret/ # "Secret 노트" 페이지
42+
│ │ ├── fonts/ # 웹폰트 관련 파일
43+
│ │ ├── favicon.ico # 웹사이트의 파비콘 설정 파일
44+
│ │ ├── global-error.tsx # 전역 에러 페이지 (에러 발생 시 보여질 컴포넌트)
45+
│ │ ├── layout.tsx # 공통 레이아웃 (Header, Footer 포함)
46+
│ │ ├── not-found.tsx # 404 Not Found 페이지
47+
│ │ ├── page.tsx # 메인 홈 페이지 ("/" 경로)
48+
│ ├── components/ # 재사용 가능한 UI 컴포넌트 디렉토리
49+
│ │ ├── Button.tsx # 재사용 가능한 버튼 컴포넌트
50+
│ │ ├── Footer.tsx # 하단 공통 Footer 컴포넌트
51+
│ │ ├── Header.tsx # 상단 공통 Header 컴포넌트
52+
│ │ ├── Loader.tsx # 로딩 애니메이션 컴포넌트
53+
│ │ ├── Navigation.tsx # 네비게이션 바 컴포넌트
54+
│ ├── styles/ # 전역 스타일 관리
55+
│ │ ├── global.css # 프로젝트 전역 스타일 파일
56+
│ ├── types/ # TypeScript 타입 정의 디렉토리
57+
│ │ ├── api.ts # API 요청/응답에 사용되는 타입 정의
58+
│ │ ├── props.ts # 컴포넌트 Props에 사용되는 타입 정의
59+
│ ├── utils/ # 유틸리티 함수 디렉토리
60+
│ ├── api.ts # API 호출 관련 함수
61+
|
62+
├── .gitattributes # Git 속성 관리 (예: 줄바꿈 설정, 파일 속성 제어)
3063
├── .gitignore # Git에 포함하지 않을 파일 설정
64+
├── .prettierrc # Prettier 코드 포맷터 설정 파일
3165
├── eslintrc.json # ESLint 설정 파일
3266
├── next-env.d.ts # TypeScript Next.js 환경 정의
3367
├── next.config.ts # Next.js 설정 파일
@@ -39,68 +73,66 @@
3973
├── tsconfig.json # TypeScript 설정 파일
4074
```
4175

42-
43-
4476
## 🔧 **설치 및 실행**
4577

4678
### 1. **프로젝트 가져오기**
79+
4780
```bash
4881
git clone https://github.com/Lab-Semtle/semtle-web-client-0.2.git
4982
```
5083

5184
### 2. **브랜치 분기**
85+
5286
```bash
5387
git checkout -b feature/#[이슈번호]
5488
git push origin feature/#[이슈번호]
5589
```
5690

5791
### 3. **패키지 설치**
92+
5893
```bash
5994
npm install
6095
```
6196

6297
### 4. **개발 서버 실행**
98+
6399
```bash
64100
npm run dev
65101
```
66-
- 실행 후 브라우저에서 [http://localhost:3000](http://localhost:3000)을 열어 확인하세요.
67-
68-
69-
70102

103+
- 실행 후 브라우저에서 [http://localhost:3000](http://localhost:3000)을 열어 확인하세요.
71104

72105
## 🌟 **기술 스택**
73-
...
74-
75106

107+
...
76108

77109
## 📜 **스크립트**
78-
...
79110

111+
...
80112

81113
## 🛠️ **환경 변수 설정**
114+
82115
프로젝트의 민감한 정보를 관리하기 위해 `.env` 파일을 사용합니다.
83116

84117
### `.env.example`
118+
85119
```plaintext
86120
API_URL=
87121
DATABASE_URL=
88122
NEXT_PUBLIC_API_KEY=
89123
```
124+
90125
- `.env` 파일을 작성한 후, 위의 형식에 맞게 정보를 추가하세요.
91126
- `.env` 파일은 `.gitignore`에 포함되어야 합니다.
92127

93-
94-
95128
## 🧑 **TEAM**
96-
...
97-
98129

99-
100-
## 🔗 **참고 자료**
101130
...
102131

132+
## 🔗 **참고 자료**
103133

134+
...
104135

105136
## 🐞 **문제 및 개선 사항**
106-
...
137+
138+
...

README2.md

Lines changed: 0 additions & 138 deletions
This file was deleted.

0 commit comments

Comments
 (0)