오윤석

update readme.md

1 -# 메이플스토리 스펙 계산기
...\ No newline at end of file ...\ No newline at end of file
1 +## About The Project
2 +![screenshot](images/screenshot.png)
3 +
4 +본 프로젝트는 메이플스토리 게임의 스펙을 계산하여 어떤 스탯을 올리는 것이 효율적인지를 계산해주는 툴입니다. 닉네임 입력만으로 간단하게 스탯 효율을 계산할 수 있습니다.
5 +
6 +### Built With
7 +* [Docker](https://github.com/docker)
8 +* [Express](https://github.com/expressjs/express)
9 +* [Nginx](https://github.com/nginx/nginx)
10 +* [Svelte](https://github.com/sveltejs/svelte)
11 +
12 +## Getting Started
13 +
14 +### Prerequisites
15 +
16 +* docker
17 +
18 +Docker를 사용하여 구동이 가능합니다. docker-compose가 사용이 가능한 환경이어야 합니다. [설치 안내](https://docs.docker.com/compose/install/)
19 +
20 +### Installation
21 +1. clone the repository
22 +```
23 +git clone http://khuhub.khu.ac.kr/2017104005/oss-maple.git
24 +```
25 +
26 +2. branch release
27 +```
28 +git branch release
29 +```
30 +
31 +3. docker on
32 +```
33 +docker-compose up
34 +```
35 +
36 +4. (optional) 80(http) 또는 443(https) 포트로 포워딩
37 +
38 +포워딩하지 않은 경우 8081 포트로 프로젝트가 실행됩니다.
39 +
40 +## Preview
41 +
42 +[maplespec.ga](https://maplespec.ga)
43 +
44 +공개설정이 된 메이플스토리 캐릭터 이름(ex 88분고민한닉, 54분고민한닉, 72분고민한닉)을 입력하여 사용할 수 있습니다.
45 +
46 +## Contributing
47 +
48 +프로젝트에 기여하고 싶으신 분들은 아래 절차를 따라주시기 바랍니다.
49 +
50 +1. 프로젝트 fork
51 +2. feature branch 생성 (`git checkout -b feature/n-name`) (프로젝트 feature를 구분하기 위해 feature name 앞에 숫자를 넣습니다.)
52 +3. commit (`git commit -m "Add feature`)
53 +4. push (`git push origin feature/n-name`)
54 +5. pull request 생성
55 +
56 +본 프로젝트는 기여를 환영합니다.
57 +
58 +## Contact
59 +
60 +* 오윤석, dhdbstjr98@khu.ac.kr
61 +* 오윤석, admin@com1.kr
...\ No newline at end of file ...\ No newline at end of file
......