diff --git a/README.md b/README.md index 5fb88a3637e667d81edf36264cde77cf9bb33125..99771381982aabcb854c4af59d15cf03d05c455d 100644 --- a/README.md +++ b/README.md @@ -1 +1,127 @@ # EUE + +## INDEX + +**1. [프로젝트 구성](#1.-프로젝트-구성)
** +**2. [프로젝트 설치](#2.-프로젝트-설치)** + +- 2-1. [Git](#2-1.-Git) +- 2-2. [Zip File](#2-2.-Zip-File) + +**3. [프로젝트 실행](#3.-프로젝트-실행)** + +- 3-1. [아두이노](#3-1.-아두이노) +- 3-2. [Client (React)](<#3-2.-Client-(React)>) +- 3-3. [Server (Express.js)](<#3-3.-Server-(Express.js)>) + +
+ +--- + +
+ +## 1. 프로젝트 구성 + + ∟ arduino + ∟ code + ∟ main_inside + ∟ main_outside + ∟ info.md + ∟ client + ∟ server + ∟ (data) + ∟ src + ∟ controllers + ∟ db + ∟ routers + ∟ views + +
+
+ +## 2. 프로젝트 설치 + +
+ +### 2-1. Git + +깃을 이용할 때는 프로젝트를 다운받을 경로로 이동한 뒤 다음의 명령어를 복사 및 붙여넣기 합니다. + +```console +git clone https://github.com/dorakang612/EUE.git +``` + +
+ +**또는** + +
+ +### 2-2. Zip File + +프로젝트의 zip 파일을 에서 받은 뒤 압축을 해제하여 설치합니다. + +
+
+ +## 3. 프로젝트 실행 + +
+ +### 3-1. 아두이노 + +1. 에서 Arduino IDE를 설치합니다. + + > - 이미 설치를 해두셨다면 바로 아래부터 진행합니다. + > + > - 최근에는 Arduino에서 Online IDE를 서비스해주는 것 같습니다. 아두이노를 많이 다루지 않아도 되므로, 필요에 따라 IDE설치 보다 Online IDE를 사용하는 것을 고려해보시기 바랍니다.(해당 내용은 추후 서비스 사용 후 수정 예정) + +2. 프로젝트에서 다음의 두 파일을 수정합니다. + + - arduino/code/main_inside/main_inside.io + - arduino/code/main_outside/main_outside.io + + 위의 두 파일에 대해 본인의 상황에 맞게 다음의 것들을 수정합니다. + + 1. SSID (공유기의 이름) + 2. SSPW (공유기의 비밀번호) + 3. EUEIP (웹사이트 아이피주소) + 4. EUEPORT (웹사이트 포트번호) + +3. 아두이노 메인보드를 PC에 연결합니다. +4. 실내용 아두이노 보드에는 main_inside.io를 업로드합니다. +5. 외부용 아두이노 보드에는 main_inside.io를 업로드합니다. + +> 프로젝트를 진행하는데 있어 사용한 모듈 정보는 arduino/info.md를 참고하시면 됩니다. + +
+ +### 3-2. Client (React) + +
+ +### 3-3. Server (Express.js) + +1. /server 경로상으로 이동한 뒤 다음의 명령어를 실행합니다. + + ```console + npm install + ``` + + 위의 명령어를 통해 프로젝트가 사용하는 모든 node module들을 설치합니다. + +2. Mysql을 통해 Database를 생성합니다. + +3. 생성된 Database 상에서 다음의 명령어를 입력해 Relation들을 생성합니다. + + ```console + mysql> source server/src/db/eue.sql + ``` + +4. /server 경로상으로 이동한 뒤 db/dbsetting.js를 다음의 명령어로 실행합니다. + + ```console + npx babel-node db/dbsetting.js + ``` + + 위의 명령어를 통해 Location에 관련된 Relation들에 data가 입력됩니다. diff --git a/server/.gitignore b/server/.gitignore index 8461401c58e962322790728da35d0b2721d721de..1d4d5c0742aeb8234033c4c0c41aa68a576794e8 100644 --- a/server/.gitignore +++ b/server/.gitignore @@ -1,3 +1,9 @@ +# Node Packages package-lock.json /node_modules -.env \ No newline at end of file + +# Project Environments +.env + +# Project Data +/data \ No newline at end of file