오윤석

Merge branch 'feature/3-readme' into develop

1 -# 메이플스토리 스펙 계산기
...\ No newline at end of file ...\ No newline at end of file
1 +# maplespec.ga
2 +
3 +메이플스토리 스펙업 효율을 계산해주는 웹 어플리케이션입니다.
4 +
5 +[View Demo](https://maplespec.ga)
6 +
7 +* 공개설정이 된 메이플스토리 캐릭터 이름(ex 88분고민한닉, 54분고민한닉, 72분고민한닉)을 입력하여 사용할 수 있습니다.
8 +* 해외에 서버가 있어 분석에 1분정도 시간이 소요됩니다.
9 +
10 +## About The Project
11 +![screenshot](images/screenshot.png)
12 +
13 +본 프로젝트는 메이플스토리 게임의 스펙을 계산하여 어떤 스탯을 올리는 것이 효율적인지를 계산해주는 툴입니다. 닉네임 입력만으로 간단하게 스탯 효율을 계산할 수 있습니다.
14 +
15 +### Built With
16 +* [Docker](https://github.com/docker)
17 +* [Express](https://github.com/expressjs/express)
18 +* [Nginx](https://github.com/nginx/nginx)
19 +* [Svelte](https://github.com/sveltejs/svelte)
20 +
21 +## Getting Started
22 +
23 +### Prerequisites
24 +
25 +* docker
26 +
27 +Docker를 사용하여 구동이 가능합니다. docker-compose가 사용이 가능한 환경이어야 합니다. [설치 안내](https://docs.docker.com/compose/install/)
28 +
29 +### Installation
30 +1. clone the repository
31 +```
32 +git clone http://khuhub.khu.ac.kr/2017104005/oss-maple.git
33 +```
34 +
35 +2. checkout release
36 +```
37 +git checkout release
38 +```
39 +
40 +3. docker on
41 +```
42 +docker-compose up
43 +```
44 +
45 +4. (optional) 80(http) 또는 443(https) 포트로 포워딩
46 +
47 +포워딩하지 않은 경우 8081 포트로 프로젝트가 실행됩니다.
48 +
49 +## Contributing
50 +
51 +프로젝트에 기여하고 싶으신 분들은 아래 절차를 따라주시기 바랍니다.
52 +
53 +1. 프로젝트 fork
54 +2. feature branch 생성 (`git checkout -b feature/n-name`) (프로젝트 feature를 구분하기 위해 feature name 앞에 숫자를 넣습니다.)
55 +3. commit (`git commit -m "Add feature`)
56 +4. push (`git push origin feature/n-name`)
57 +5. pull request 생성
58 +
59 +본 프로젝트는 기여를 환영합니다.
60 +
61 +## Contact
62 +
63 +* 오윤석, dhdbstjr98@khu.ac.kr
64 +* 오윤석, admin@com1.kr
...\ No newline at end of file ...\ No newline at end of file
......
1 -*Looking for a shareable component template? Go here --> [sveltejs/component-template](https://github.com/sveltejs/component-template)*
2 -
3 ----
4 -
5 -# svelte app
6 -
7 -This is a project template for [Svelte](https://svelte.dev) apps. It lives at https://github.com/sveltejs/template.
8 -
9 -To create a new project based on this template using [degit](https://github.com/Rich-Harris/degit):
10 -
11 -```bash
12 -npx degit sveltejs/template svelte-app
13 -cd svelte-app
14 -```
15 -
16 -*Note that you will need to have [Node.js](https://nodejs.org) installed.*
17 -
18 -
19 -## Get started
20 -
21 -Install the dependencies...
22 -
23 -```bash
24 -cd svelte-app
25 -npm install
26 -```
27 -
28 -...then start [Rollup](https://rollupjs.org):
29 -
30 -```bash
31 -npm run dev
32 -```
33 -
34 -Navigate to [localhost:5000](http://localhost:5000). You should see your app running. Edit a component file in `src`, save it, and reload the page to see your changes.
35 -
36 -By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the `sirv` commands in package.json to include the option `--host 0.0.0.0`.
37 -
38 -
39 -## Building and running in production mode
40 -
41 -To create an optimised version of the app:
42 -
43 -```bash
44 -npm run build
45 -```
46 -
47 -You can run the newly built app with `npm run start`. This uses [sirv](https://github.com/lukeed/sirv), which is included in your package.json's `dependencies` so that the app will work when you deploy to platforms like [Heroku](https://heroku.com).
48 -
49 -
50 -## Single-page app mode
51 -
52 -By default, sirv will only respond to requests that match files in `public`. This is to maximise compatibility with static fileservers, allowing you to deploy your app anywhere.
53 -
54 -If you're building a single-page app (SPA) with multiple routes, sirv needs to be able to respond to requests for *any* path. You can make it so by editing the `"start"` command in package.json:
55 -
56 -```js
57 -"start": "sirv public --single"
58 -```
59 -
60 -
61 -## Deploying to the web
62 -
63 -### With [now](https://zeit.co/now)
64 -
65 -Install `now` if you haven't already:
66 -
67 -```bash
68 -npm install -g now
69 -```
70 -
71 -Then, from within your project folder:
72 -
73 -```bash
74 -cd public
75 -now deploy --name my-project
76 -```
77 -
78 -As an alternative, use the [Now desktop client](https://zeit.co/download) and simply drag the unzipped project folder to the taskbar icon.
79 -
80 -### With [surge](https://surge.sh/)
81 -
82 -Install `surge` if you haven't already:
83 -
84 -```bash
85 -npm install -g surge
86 -```
87 -
88 -Then, from within your project folder:
89 -
90 -```bash
91 -npm run build
92 -surge public my-project.surge.sh
93 -```