Skip to content

Commit 6d4b633

Browse files
authored
docs: 리드미 꾸미기
* Create README.md * Create LICENSE * Update README.md * Update README.md
1 parent c2e13e1 commit 6d4b633

File tree

2 files changed

+246
-0
lines changed

2 files changed

+246
-0
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 DASOM
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 225 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,225 @@
1+
![Slide 16_9 - 1](https://github.com/user-attachments/assets/ecb1ac70-0ee0-4383-bd15-fc8dba47b443)
2+
## 2025학년도 다솜 홈페이지
3+
4+
[![Netlify Status](https://api.netlify.com/api/v1/badges/a81b10db-e49b-44a5-b55e-650bc963fe63/deploy-status)](https://app.netlify.com/sites/dmu-dasom/deploys)
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6+
> <b>개발 기간 : 2025.02.05 - 2025.03.01 <br> 배포 주소 : <a href="https://dmu-dasom.or.kr">https://dmu-dasom.or.kr</a></b>
7+
>
8+
<br>
9+
10+
## 2025 DASOM MAKERS
11+
12+
> 다솜 메이커스
13+
>
14+
15+
다솜 홈페이지 유지보수 및 개발을 담당하는 팀입니다.
16+
17+
| **분야** | **이름** | **포지션** |
18+
| --- | --- | --- |
19+
| PM | <a href="https://github.com/titeotty">최도현</a> | **프론트엔드 리드**, 프론트 인프라 구축 & 서버 연동 및 배포, 화면 UI 구현, <br> UI/UX, GUI 디자인, 백엔드 API 및 DB 구축 |
20+
| 백엔드 | <a href="https://github.com/ysw789">유승완</a> | **백엔드 리드**, 백엔드 인프라 구축 & 서버 연동 및 배포, API 및 DB 구축 |
21+
| 백엔드 | <a href="https://github.com/hodoon">윤도훈</a> | **백엔드**, API 및 DB 구축 |
22+
| 프론트엔드 | <a href="https://github.com/sooh329">김수현</a> | **프론트엔드**, 화면 UI 구현, API 연동 |
23+
| 프론트엔드 | <a href="https://github.com/kim3360">김태우</a> | **프론트엔드**, 화면 UI 구현, API 연동 |
24+
| 프론트엔드 | <a href="https://github.com/limtjdghks">임성환</a> | **프론트엔드**, 화면 UI 구현, API 연동 |
25+
26+
<br>
27+
28+
## 기술 스택
29+
30+
### FE
31+
32+
![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)
33+
![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
34+
![TailwindCSS](https://img.shields.io/badge/tailwindcss-%2338B2AC.svg?style=for-the-badge&logo=tailwind-css&logoColor=white)
35+
![ESLint](https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge&logo=eslint&logoColor=white)
36+
![Prettier](https://img.shields.io/badge/prettier-%23F7B93E.svg?style=for-the-badge&logo=prettier&logoColor=black)
37+
![Yarn](https://img.shields.io/badge/yarn-%232C8EBB.svg?style=for-the-badge&logo=yarn&logoColor=white)
38+
![React Router](https://img.shields.io/badge/React_Router-CA4245?style=for-the-badge&logo=react-router&logoColor=white)
39+
![Framer](https://img.shields.io/badge/Framer-black?style=for-the-badge&logo=framer&logoColor=blue)
40+
![Testing-Library](https://img.shields.io/badge/-TestingLibrary-%23E33332?style=for-the-badge&logo=testing-library&logoColor=white)
41+
42+
### BE
43+
44+
![Java](https://img.shields.io/badge/java-%23ED8B00.svg?style=for-the-badge&logo=openjdk&logoColor=white)
45+
![Spring](https://img.shields.io/badge/springboot-%236DB33F.svg?style=for-the-badge&logo=springboot&logoColor=white)
46+
![Oracle](https://img.shields.io/badge/Oracle-F80000?style=for-the-badge&logo=oracle&logoColor=white)
47+
![Redis](https://img.shields.io/badge/redis-%23DD0031.svg?style=for-the-badge&logo=redis&logoColor=white)
48+
![JUnit](https://img.shields.io/badge/Junit5-25A162?style=for-the-badge&logo=junit5&logoColor=white)
49+
![Spring Security](https://img.shields.io/badge/Spring_Security-6DB33F?style=for-the-badge&logo=Spring-Security&logoColor=white)
50+
![Gradle](https://img.shields.io/badge/Gradle-02303A.svg?style=for-the-badge&logo=Gradle&logoColor=white)
51+
![Postman](https://img.shields.io/badge/Postman-FF6C37?style=for-the-badge&logo=postman&logoColor=white)
52+
53+
### DESIGN
54+
![Figma](https://img.shields.io/badge/figma-%23F24E1E.svg?style=for-the-badge&logo=figma&logoColor=white)
55+
![Adobe Illustrator](https://img.shields.io/badge/adobe%20illustrator-%23FF9A00.svg?style=for-the-badge&logo=adobe%20illustrator&logoColor=white)
56+
![Adobe Photoshop](https://img.shields.io/badge/adobe%20photoshop-%2331A8FF.svg?style=for-the-badge&logo=adobe%20photoshop&logoColor=white)
57+
58+
### VERSION CONTROL
59+
![Git](https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white)
60+
![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)
61+
62+
### INFRA
63+
![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white)
64+
![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white)
65+
![Nginx](https://img.shields.io/badge/nginx-%23009639.svg?style=for-the-badge&logo=nginx&logoColor=white)
66+
![Netlify](https://img.shields.io/badge/netlify-%23000000.svg?style=for-the-badge&logo=netlify&logoColor=#00C7B7)
67+
68+
### DOCS & COMMUNICATION
69+
![Swagger](https://img.shields.io/badge/-Swagger-%23Clojure?style=for-the-badge&logo=swagger&logoColor=white)
70+
![Notion](https://img.shields.io/badge/Notion-%23000000.svg?style=for-the-badge&logo=notion&logoColor=white)
71+
![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=for-the-badge&logo=discord&logoColor=white)
72+
<br>
73+
74+
## 컨벤션
75+
76+
### Commit Convention
77+
78+
| 태그 | 설명 | 예시 |
79+
| --- | --- | --- |
80+
| feat | 새로운 기능 추가 | `feat: 로그인 기능 추가` |
81+
| fix | 버그 수정 | `fix: 로그인 예외 처리 버그 수정` |
82+
| docs | README 등의 문서 수정 | `docs: API 명세 업데이트` |
83+
| style | 코드 스타일 변경 | `style: 코드 포맷팅 개선` |
84+
| refactor | 기능 변경 없이 코드 내부 구조 리팩토링 | `refactor: 로그인 처리 로직 리팩토링` |
85+
| test | 테스트 케이스 작성 혹은 수정 | `test: 사용자 인증 로직 테스트 케이스 추가` |
86+
| chore | 라이브러리 버전 수정, 패키지 관리 등 | `chore: 의존성 버전 업데이트` |
87+
| comment | 주석 추가 / 수정 | `comment: 불필요한 주석 제거` |
88+
| hotfix | 배포된 버전에서의 급한 버그 수정 | `hotfix: 서버 Timezone 설정 변경` |
89+
| rename | 파일, 클래스 등의 이름 변경 | `rename: UserController → AuthController 변경` |
90+
| remove | 파일, 클래스 등의 삭제 | `remove: 사용하지 않는 DTO 제거` |
91+
| cicd | CI/CD 관련 설정 | `cicd: Github Actions workflow 추가` |
92+
| design | 애니메이션, 컬러 등의 디자인 수정 | `design: hover 애니메이션 추가` |
93+
94+
### Issue Template
95+
96+
```markdown
97+
# [태그] 제목
98+
(예: [feat] 로그인 기능 추가)
99+
100+
## 목적
101+
- 해당 Issue가 발생한 원인과 배경을 설명한다.
102+
- 예: 회원 기능 구현을 위한 로그인 기능 추가 필요
103+
- 문제점이나 개선해야 할 사항을 기술한다.
104+
- 예: 사용자 인증 과정에서 빈약한 예외 처리로 인한 오류 발생 위험 제거
105+
106+
## 상세 내용
107+
- 구현할 기능 또는 수정 사항에 대한 구체적인 설명
108+
- 예: 이메일 및 비밀번호 입력값 검증 로직 추가, OAuth 연동 검토
109+
- 참고할 자료나 관련 디자인, API 명세 등을 첨부(링크 포함 가능)
110+
111+
## 추가 사항 (필요 시)
112+
- 관련 이슈 번호, 담당자, 예상 완료일, 테스트 방법 등 기타 참고해야 할 사항을 기재
113+
```
114+
115+
### PR Template
116+
117+
```markdown
118+
# [태그] 제목
119+
(예: [feat] 사용자 인증 기능 추가)
120+
121+
## Issue
122+
- 예시: #111, #112
123+
(해당 PR과 관련된 이슈 번호를 명시하여 추적 용이성을 확보)
124+
125+
## 변경 내용
126+
- 이번 PR에서 어떤 변경이 이루어졌는지 간략하게 기술합니다.
127+
(예: 기존 로그인 API에 JWT 기반 인증 로직 추가)
128+
129+
## 구현 사항
130+
- 새로운 기능 구현 내용 및 기존 코드 수정 경위를 상세하게 설명합니다.
131+
(예: 로그인 요청 처리 로직 개선, 예외 처리 추가, API 응답 포맷 변경 등)
132+
133+
## 테스트 (필요 시)
134+
- 적용된 테스트 방법과 결과를 기록합니다.
135+
(예: 단위 테스트 결과, 통합 테스트 진행 및 QA 결과, 관련 스크린샷 첨부)
136+
137+
## 참고 사항 (필요 시)
138+
- 추가적으로 검토가 필요한 사항이나 관련 문서, 디자인 파일 등의 링크를 첨부합니다.
139+
(예: API 명세서, 디자인 목업 파일 링크 등)
140+
```
141+
142+
## 패키지 구조
143+
144+
### 백엔드
145+
```
146+
dmu.dasom.api
147+
├── global
148+
│ ├── admin
149+
│ │ ├── controller
150+
│ │ ├── dto
151+
│ │ └── service
152+
│ ├── auth
153+
│ │ ├── config
154+
│ │ ├── filter
155+
│ │ ├── handler
156+
│ │ ├── jwt
157+
│ │ └── userdetails
158+
│ └── swagger
159+
│ └── SwaggerConfig
160+
└── domain
161+
├── common
162+
│ ├── exception
163+
│ │ ├── CustomControllerAdvice
164+
│ │ ├── CustomException
165+
│ │ ├── ErrorCode
166+
│ │ └── ErrorResponse
167+
│ └── BaseEntity
168+
├── member
169+
│ ├── controller
170+
│ ├── dto
171+
│ ├── entity
172+
│ ├── enums
173+
│ ├── repository
174+
│ └── service
175+
├── recruit
176+
│ ├── controller
177+
│ ├── dto
178+
│ ├── entity
179+
│ ├── enums
180+
│ ├── repository
181+
│ └── service
182+
└── … (기타 도메인)
183+
```
184+
185+
### 프론트엔드
186+
```
187+
├─ src
188+
│ ├─ assets
189+
│ │ ├─ images
190+
│ │ └─ styles # css 설정 등
191+
│ ├─ components
192+
│ │ ├─ UI # 재사용 가능한 UI 컴포넌트 ex)버튼, 입력폼
193+
│ │ └─ layout # 헤더, 푸터 등 레이아웃 컴포넌트들
194+
│ ├─ context
195+
│ ├─ hooks
196+
│ │ └─ useWindowSize.tsx
197+
│ ├─ pages
198+
│ │ ├─ Main.tsx
199+
│ │ ├─ FAQ.tsx
200+
│ │ ├─ News.tsx
201+
│ │ ├─ NewsInfo.tsx
202+
│ │ ├─ CoreMembers.tsx
203+
│ │ ├─ Login.tsx
204+
│ │ ├─ Recruit.tsx
205+
│ │ ├─ RecruitCheck.tsx
206+
│ │ ├─ RecruitCheckFinal.tsx
207+
│ │ ├─ RecruitMeeting.tsx
208+
│ │ ├─ RecruitResult.tsx
209+
│ │ ├─ RecruitSubmit.tsx
210+
│ │ ├─ RecruitSubmitMeeting.tsx
211+
│ │ ├─ UserMain.tsx
212+
│ │ └─ admin
213+
│ │ ├─ AdminMain.tsx
214+
│ │ ├─ ManMembers.tsx
215+
│ │ ├─ ManApplicants.tsx
216+
│ │ ├─ ManRecruitDate.tsx
217+
│ │ └─ ManNews.tsx
218+
│ ├─ utils
219+
│ │ └─ utils.ts
220+
│ └─ types
221+
├─ App.tsx
222+
├─ index.tsx
223+
├─ react-app-env.d.ts
224+
└─ setupTests.ts
225+
```

0 commit comments

Comments
 (0)