|
4 | 4 | <br /> |
5 | 5 | <div align="center"> |
6 | 6 | <a href="https://github.com/othneildrew/Best-README-Template"> |
7 | | - <img src="images/logo.png" alt="Logo" width="80" height="80"> |
| 7 | + <img src="https://user-images.githubusercontent.com/19871043/137923020-43a87404-7754-4c22-83e7-1b428da35ef7.png" alt="Logo" width="80" height="80"> |
8 | 8 | </a> |
9 | 9 |
|
10 | 10 | <h3 align="center">내 손 안의 진중문고, HandyLib</h3> |
|
21 | 21 | <!-- TABLE OF CONTENTS --> |
22 | 22 |
|
23 | 23 |
|
24 | | -<span>Readme 목차</span> |
25 | | - <ol> |
26 | | - <li> |
27 | | - <a href="#about-the-project">프론트엔드</a> |
28 | | - <ul> |
29 | | - <li><a href="#built-with">개발 도구</a></li> |
30 | | - </ul> |
31 | | - </li> |
32 | | - <li><a href="#pageExplanation">페이지 소개</a> |
33 | | - <ul> |
34 | | - <li>플로우차트</li> |
35 | | - <li>메인 페이지 소개</li> |
36 | | - <li>기타 페이지 소개</li> |
37 | | - </ul> |
38 | | - </li> |
39 | | - <li>데이터 모델 |
40 | | - <ul> |
41 | | - <li>객체 구조</li> |
42 | | - <li>Primary coior 정의</li> |
43 | | - </ul> |
44 | | - </li> |
45 | | - <li>사용한 constants</li> |
46 | | - <li>발전 방향</li> |
47 | | - |
48 | | - <li> |
49 | | - <a href="#getting-started">설치 방법</a> |
50 | | - <ul> |
51 | | - <li><a href="#prerequisites">요구사항</a></li> |
52 | | - <li><a href="#installation">설치</a></li> |
53 | | - </ul> |
54 | | - </li> |
55 | | - <li><a href="#usage">사용법</a></li> |
56 | | - <li><a href="#license">라이센스</a></li> |
57 | | - <li><a href="#contact">개발자 정보</a></li> |
58 | | - </ol> |
59 | | - |
60 | 24 | <!-- ABOUT THE PROJECT --> |
61 | | -<!-- <img src = "" width = 300> --> |
62 | | -# 프론트엔드 |
63 | 25 |
|
64 | | -[![Product Name Screen Shot][product-screenshot]](https://example.com) |
| 26 | +### 개요 |
| 27 | + |
65 | 28 |
|
66 | 29 | 프론트엔드에서는 flutter를 이용하여 앱 UI/UX 및 개인화 기능을 개발하였습니다. |
67 | 30 |
|
|
182 | 145 | <img src = "https://user-images.githubusercontent.com/19871043/137643200-6a735ec4-ffe7-48ac-8f93-57bd5503bd49.png" height = 500> <img src = "https://user-images.githubusercontent.com/19871043/137643202-eb1192b6-dc97-4118-acb0-181b9de56179.png" height = 500> |
183 | 146 | <br><br> |
184 | 147 |
|
185 | | -## 기타 페이지 |
186 | | -회원가입 + 로그인 등 |
187 | | - |
188 | | - |
189 | | -# 데이터 모델 |
190 | | -## 객체 구조 |
191 | | -### User |
192 | | -| |name|userId|password|email|unit|rank| |
193 | | -|--|----|------|--------|-----|----|----| |
194 | | -| |사용자명|사용자 id|사용자 비밀번호|사용자 이메일|사용자 소속 부대|사용자 계급| |
195 | | - |
196 | | - |
197 | | -### Built With |
198 | | - |
199 | | -This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples. |
200 | | - |
201 | | -- [Next.js](https://nextjs.org/) |
202 | | -- [React.js](https://reactjs.org/) |
203 | | -- [Vue.js](https://vuejs.org/) |
204 | | -- [Angular](https://angular.io/) |
205 | | -- [Svelte](https://svelte.dev/) |
206 | | -- [Laravel](https://laravel.com) |
207 | | -- [Bootstrap](https://getbootstrap.com) |
208 | | -- [JQuery](https://jquery.com) |
209 | | - |
210 | | -<p align="right">(<a href="#top">back to top</a>)</p> |
211 | | - |
212 | | -<!-- GETTING STARTED --> |
213 | | - |
214 | | -## Getting Started |
215 | | - |
216 | | -This is an example of how you may give instructions on setting up your project locally. |
217 | | -To get a local copy up and running follow these simple example steps. |
218 | | - |
219 | | -### Prerequisites |
220 | | - |
221 | | -This is an example of how to list things you need to use the software and how to install them. |
222 | | - |
223 | | -- npm |
224 | | - ```sh |
225 | | - npm install npm@latest -g |
226 | | - ``` |
227 | | - |
228 | | -### Installation |
| 148 | +### 기타 페이지 |
229 | 149 |
|
230 | | -1. Get a free API Key at [https://example.com](https://example.com) |
231 | | -2. Clone the repo |
232 | | - ```sh |
233 | | - git clone https://github.com/your_username_/Project-Name.git |
234 | | - ``` |
235 | | -3. Install NPM packages |
236 | | - ```sh |
237 | | - npm install |
238 | | - ``` |
239 | | -4. Enter your API in `config.js` |
240 | | - ```js |
241 | | - const API_KEY = "ENTER YOUR API"; |
242 | | - ``` |
243 | | - |
244 | | -<p align="right">(<a href="#top">back to top</a>)</p> |
245 | | - |
246 | | -<!-- USAGE EXAMPLES --> |
247 | | - |
248 | | -## Usage |
249 | | - |
250 | | -Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. |
251 | | - |
252 | | -_For more examples, please refer to the [Documentation](https://example.com)_ |
253 | | - |
254 | | -<p align="right">(<a href="#top">back to top</a>)</p> |
255 | | - |
256 | | - |
257 | | -<!-- LICENSE --> |
258 | | - |
259 | | -## License |
260 | | - |
261 | | -Distributed under the MIT License. See `LICENSE.txt` for more information. |
262 | | - |
263 | | -<p align="right">(<a href="#top">back to top</a>)</p> |
| 150 | +<img src = "https://user-images.githubusercontent.com/19871043/137919898-85f77674-a1ba-463c-abbf-88cd42e27c4b.png" height = 500> <img src = "https://user-images.githubusercontent.com/19871043/137920033-060e34dd-78bf-4380-975a-35bd961eaa78.png" height = 500> |
| 151 | +<br><br> |
264 | 152 |
|
265 | | -<!-- CONTACT --> |
| 153 | +개인화된 추천 시스템을 제공하기 위한 회원가입과 로그인 기능을 제공합니다. |
| 154 | +<br><br> |
266 | 155 |
|
267 | | -## Contact |
268 | 156 |
|
269 | | -Your Name - [@your_twitter](https://twitter.com/your_username) - email@example.com |
| 157 | +# 데이터 모델 |
| 158 | +## 객체 구조 |
270 | 159 |
|
271 | | -Project Link: [https://github.com/your_username/repo_name](https://github.com/your_username/repo_name) |
| 160 | +### User |
| 161 | +|객체명|type|의미| |
| 162 | +|-|-|-| |
| 163 | +|name|String|이름| |
| 164 | +|userId|String|아이디| |
| 165 | +|password|String|비밀번호| |
| 166 | +|email|String|이메일| |
| 167 | +|unit|String|소속 부대| |
| 168 | +|rank|String|계급| |
| 169 | + |
| 170 | +### Book |
| 171 | +전자책 객체 |
| 172 | +|객체명|type|의미| |
| 173 | +|-|-|-| |
| 174 | +|title|String|도서명| |
| 175 | +|author|String|작가| |
| 176 | +|pubDate|String|출판일자| |
| 177 | +|coverUrl|String|표지 url| |
| 178 | +|isbn|String|isbn10| |
| 179 | +|publisher|String|출판사| |
| 180 | +|category|String|카테고리| |
| 181 | + |
| 182 | +### Post |
| 183 | +게시글 객체 |
| 184 | +|객체명|type|의미| |
| 185 | +|-|-|-| |
| 186 | +|postId|int?|게시글 번호| |
| 187 | +|postName|String?|제목| |
| 188 | +|postTag|String?|태그| |
| 189 | +|author|String?|작성자| |
| 190 | +|content|String?|내용| |
| 191 | +|timestamp|String?|작성 시각| |
| 192 | +|postCommentList|List\<Comment\>|댓글 리스트| |
| 193 | + |
| 194 | +### Board |
| 195 | +게시판 객체 |
| 196 | +|객체명|type|의미| |
| 197 | +|-|-|-| |
| 198 | +|boardId|int?|게시판 번호| |
| 199 | +|boardName|String?|게시판 이름| |
| 200 | +|boardTag|String?|게시판 태그| |
| 201 | + |
| 202 | +### Comment |
| 203 | +댓글 객체 |
| 204 | +|객체명|type|의미| |
| 205 | +|-|-|-| |
| 206 | +|content|String?|댓글 내용| |
| 207 | +|author|String?|작성자| |
| 208 | +|timestamp|String?|작성 시간| |
| 209 | + |
| 210 | +### Unitbook |
| 211 | +부대 내 도서 객체 |
| 212 | +|객체명|type|의미| |
| 213 | +|-|-|-| |
| 214 | +|title|String|도서명| |
| 215 | +|author|String|작가| |
| 216 | +|pubDate|String|출판일자| |
| 217 | +|coverUrl|String|표지 url| |
| 218 | +|isbn|String|isbn10| |
| 219 | +|publisher|String|출판사| |
| 220 | +|category|String|카테고리| |
| 221 | + |
| 222 | +### Primary color 정의 |
| 223 | +본 프로그램에서는 두 개의 메인 색을 사용하고 있습니다. |
| 224 | + |
| 225 | + |
| 226 | +R 224 G 240 B 227 |
| 227 | + |
| 228 | + |
| 229 | +R 184 G 216 B 190 |
| 230 | + |
| 231 | +# 설치방법 |
| 232 | + |
| 233 | +## 요구사항 |
| 234 | + |
| 235 | +## 설치 |
| 236 | + |
| 237 | +## 사용법 |
| 238 | + |
| 239 | +## 라이센스 |
| 240 | +이 프로그램은 MIT 라이센스를 적용합니다. |
| 241 | + |
| 242 | +## 한계와 발전방향 |
| 243 | +본 프로그램은 짧은 시간 내에 제작된 것으로 기본적인 기능 제공에 중점을 두고 있습니다. |
| 244 | +<br><br> |
| 245 | +전자책 시스템은 Aladin API에서 파싱해온 정보를 이용하는데, Aladin API는 책의 제목, 설명, isbn과 같은 일부 정보만 제공하고 |
| 246 | +<br><br> |
| 247 | +당연하게도 전자책 db는 제공하고 있지 않습니다. 따라서 이 프로그램에서는 전자책을 실제로 열람할 수 없습니다. |
| 248 | +<br><br> |
| 249 | +만약 실제로 이 프로그램이 사용된다면 기존의 각 군 도서관 전자책 시스템 db를 가져와서 장병들이 열람할 수 있도록 수정할 필요가 있습니다. |
| 250 | +<br><br> |
272 | 251 |
|
273 | | -<p align="right">(<a href="#top">back to top</a>)</p> |
| 252 | +## 개발자 정보 |
| 253 | +|개발자명|제작 분야|Contact|Page| |
| 254 | +|-|-|-|-| |
| 255 | +|홍지환|로그인, 회원가입, 부대 도서관, 게시판, 나의 프로필|eat333@naver.com|| |
| 256 | +|김민준|UI/UX 디자인, 전자도서관, 책 대출, 검색기능, 전자책|mamy0320@naver.com|| |
0 commit comments