|
1 |
| -# SOPKATHON-33-Server |
2 |
| - |
3 | 1 | > 33th DO SOPT SOPKATHON :: **re:ing** <br>
|
4 | 2 | >
|
5 | 3 | > 33기 솝커톤 iOS 1조 프로젝트
|
|
72 | 70 | | RDS 세팅 | `승환🤖` | 완료 |
|
73 | 71 | | CI/CD 세팅 | `동규🍣` | 완료 |
|
74 | 72 | | README 작성 | `동규🍣` | 완료 |
|
75 |
| -| DB 설계 | `승환🤖` `동규🍣` | 진행 중 | |
76 |
| -| API 명세서 작성 | `승환🤖` `동규🍣` | 진행 예정 | |
77 |
| -| API 개발 | `승환🤖` `동규🍣` | 진행 예정 | |
| 73 | +| DB 설계 | `승환🤖` `동규🍣` | 완료 | |
| 74 | +| API 명세서 작성 | `승환🤖` `동규🍣` | 완료 | |
| 75 | +| API 개발 | `승환🤖` `동규🍣` | 완료 | |
78 | 76 |
|
79 | 77 | </div>
|
80 | 78 |
|
81 | 79 |
|
82 | 80 | ### ⭐️ 우리 사랑하기로 했어요 ⭐️
|
83 |
| -(Comming Soon....) <br/> |
84 |
| -<img width="550" height="400" alt="team_image" src=""> |
| 81 | +<img width="550" height="400" alt="team_image" src="https://github.com/SOPT-33-iOS-Team-1/SOPKATHON_33-Server/assets/69035864/9805a4f5-b6f5-40de-9b52-324f2ebfa21f"> |
85 | 82 |
|
86 | 83 |
|
87 | 84 | <br/>
|
|
103 | 100 |
|
104 | 101 | ---
|
105 | 102 | > 자세한 테이블 정보는 다음 노션 페이지에 정리해둘 예정입니다! (Comming Soon...)
|
106 |
| -- [📝 Database](Comming Soon...) |
| 103 | +- [📝 Database](https://www.notion.so/DB-Schema-Description-d0c91546b233435e908a1a2ab315295b?pvs=4) |
107 | 104 |
|
108 |
| -<img width="884" alt="erd_image" src=""> |
| 105 | +<img width="884" alt="erd" src="https://github.com/SOPT-33-iOS-Team-1/SOPKATHON_33-Server/assets/69035864/a06f2a66-7e87-4321-b31b-ff450de1553b"> |
109 | 106 |
|
110 | 107 | <br>
|
111 | 108 |
|
112 | 109 | ## 🖇 Api 명세서
|
113 | 110 |
|
114 |
| ---- |
115 |
| -> 작성 중 |
116 |
| -
|
117 | 111 | [🍀 API 명세서](https://www.notion.so/342f6504080f4113afb4a89af506c2d7?v=a36becbc1f0f4239a802053bf782195c&pvs=4)
|
118 | 112 |
|
119 | 113 | <br>
|
120 | 114 |
|
121 | 115 | ## ⚙️ Architecture
|
122 | 116 |
|
123 | 117 | ---
|
124 |
| -<img width="884" alt="architecture_image" src=""> |
| 118 | +<img width="884" alt="architecture_image" src="https://github.com/SOPT-33-iOS-Team-1/SOPKATHON_33-Server/assets/69035864/9572b43a-18e2-4578-b496-2fd54f1dc476"> |
125 | 119 |
|
126 | 120 | <br>
|
127 | 121 |
|
128 | 122 | ## 🗂️ Project Foldering
|
129 | 123 |
|
130 |
| -- **도메인 별로 Architecture를 나눌 예정입니다.** |
131 | 124 | ```
|
| 125 | +├── 📁 .github |
| 126 | +│ ├── 📁 ISSUE_TEMPLATE |
| 127 | +| └── 📁 workflows |
| 128 | +| └── pull_request_template.md |
| 129 | +│ |
| 130 | +├── appspec.yml |
| 131 | +| |
| 132 | +├── HELP.md |
| 133 | +| |
| 134 | +├── build.gradle |
| 135 | +├── gradlew |
| 136 | +├── gradlew.bat |
| 137 | +| |
| 138 | +├── README.md |
| 139 | +| |
| 140 | +├── 📁 script |
| 141 | +│ ├── start.sh |
| 142 | +│ └── stop.sh |
| 143 | +└── 📁 src |
| 144 | + └── 📁 main |
| 145 | + ├── 📁 java |
| 146 | + │ └── 📁 org |
| 147 | + │ └── 📁 sopt |
| 148 | + │ └── 📁 sopkerton |
| 149 | + │ ├── SopkertonApplication.java |
| 150 | + │ └── 📁 common |
| 151 | + │ ├── 📁 exception |
| 152 | + │ │ ├── GlobalError.java |
| 153 | + │ │ ├── GlobalException.java |
| 154 | + │ │ ├── GlobalSuccess.java |
| 155 | + │ │ └── 📁 base |
| 156 | + │ │ ├── ErrorBase.java |
| 157 | + │ │ ├── ExceptionBase.java |
| 158 | + │ │ ├── RootEnum.java |
| 159 | + │ │ └── SuccessBase.java |
| 160 | + │ └── 📁 response |
| 161 | + │ ├── ApiResponse.java |
| 162 | + │ └── CommonControllerAdvice.java |
| 163 | + └── 📁 resources |
| 164 | + └── application.yml |
132 | 165 | ```
|
133 | 166 |
|
134 | 167 | <br>
|
135 | 168 |
|
136 | 169 | ## ♻️ 실행 방법
|
137 |
| - |
138 |
| ---- |
139 |
| - |
140 |
| - |
141 |
| -<br/> |
| 170 | +clone 받아서 application run하고 localhost:8080으로 api 명세서대로 api를 호출한다. |
142 | 171 |
|
143 | 172 |
|
144 | 173 |
|
0 commit comments