송용우

Update Readme

1 +
2 +MIT License
3 +
4 +Copyright (c) 2020 Yong-Woo Song
5 +
6 +Permission is hereby granted, free of charge, to any person obtaining a copy
7 +of this software and associated documentation files (the "Software"), to deal
8 +in the Software without restriction, including without limitation the rights
9 +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 +copies of the Software, and to permit persons to whom the Software is
11 +furnished to do so, subject to the following conditions:
12 +
13 +The above copyright notice and this permission notice shall be included in all
14 +copies or substantial portions of the Software.
15 +
16 +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 +SOFTWARE.
...\ No newline at end of file ...\ No newline at end of file
...@@ -8,19 +8,71 @@ ...@@ -8,19 +8,71 @@
8 > 8 >
9 > > 알고리즘 문제 풀이 스터디를 꾸준히 할 수 있게 돕는 웹 서비스입니다. 9 > > 알고리즘 문제 풀이 스터디를 꾸준히 할 수 있게 돕는 웹 서비스입니다.
10 10
11 +![그림1](https://user-images.githubusercontent.com/16442978/85690047-236d1d00-b70e-11ea-8d2b-480593c0daf3.png)
12 +
13 +![그림2](https://user-images.githubusercontent.com/16442978/85690058-2536e080-b70e-11ea-98cd-45fdf04084ce.png)
14 +
11 ## Features 15 ## Features
12 16
13 - 회원가입/로그인 제공 17 - 회원가입/로그인 제공
14 - Online Judge 연동 가능 (Baekjoon) 18 - Online Judge 연동 가능 (Baekjoon)
15 - 나의 학습 현황 한눈에 보기 19 - 나의 학습 현황 한눈에 보기
16 - 추천 문제 제공 20 - 추천 문제 제공
17 -- 친구와의 경쟁
18 - Slack 알리미 21 - Slack 알리미
19 22
20 ## Getting Started 23 ## Getting Started
21 24
22 -- 25 +1. Clone
26 +
27 +```
28 +git clone https://github.com/FacerAin/OSS-Jaksimsamil.git
29 +```
30 +
31 +2. Install MongoDB(Ubuntu)
32 +
33 +```
34 +sudo apt-get update
35 +sudo apt-get install -y mongodb-org
36 +sudo service mongod start
37 +```
38 +
39 +3. Set Serverfile
40 +
41 +```
42 +cd Jaksimsamil-server
43 +touch .env
44 +---TYPE THIS IN FILE----
45 +SERVER_PORT= ###
46 +MONGO_URL= ###
47 +JWT_SECRET= ###
48 +```
49 +
50 +4. Start Node Server
51 +
52 +```
53 +cd Jaksimsamil-server
54 +sudo npm install
55 +node ./index.js #Start Server
56 +```
57 +
58 +5. Set Front-end page
59 +
60 +```
61 +cd Jaksimsamil-server
62 +sudo npm install
63 +npm start #Start React
64 +```
65 +
66 +## Contributing
67 +
68 +컨트리뷰션은 언제나 환영입니다. 다음 절차를 지켜주세요!
69 +
70 +1. Fork the Project
71 +2. Create your Feature Branch
72 +3. Commit our changes
73 +4. Push to Branch
74 +5. Open a Pull Request
23 75
24 ## License 76 ## License
25 77
26 -- 78 +- MIT LICENCE
......