Flare-k

[Modified] Readme

Showing 1 changed file with 53 additions and 8 deletions
1 -# OSS Term Project using AWS, Node js 1 +# KhuTube using AWS, Node js
2 2
3 ### 경희대학교 컴퓨터공학과 강연욱 3 ### 경희대학교 컴퓨터공학과 강연욱
4 4
5 -## 내용 5 +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6 6
7 -- Node.js를 이용하여 나만의 Youtube 사이트를 제작한다. 7 +## KhuTube
8 8
9 -## 기술 Stack 9 +- Create your own Youtube site using Node.js.
10 10
11 -1. Frontend: Vanilla.js 11 +## Configuration
12 +
13 +1. Frontend: Vanilla.js(Pug Template)
12 2. Backend : Node.js 14 2. Backend : Node.js
13 3. Database: mongoDB 15 3. Database: mongoDB
14 4. A W S : EC2 16 4. A W S : EC2
15 17
18 +## Quickstart
19 +
20 +### Required File
21 +
22 +If you cloned this repo, please add the .env file in /myYoutube
23 +The .env file is ..
24 +
25 +```sh
26 +MONGO_URL = "mongodb://localhost:27017/yourDBname"
27 +PORT = "Your port number"
28 +COOKIE_SECRET = "anything"
29 +GH_ID = "Your github developer Access ID"
30 +GH_SECRET = "Your github developer Secret Key"
31 +FB_ID = "Your facebook developer Access ID"
32 +FB_SECRET = "Your facebook developer Secret Key"
33 +AWS_KEY = "Your AWS IAM Access ID"
34 +AWS_PRIVATEE_KEY = "Your AWS IAM Secret Key"
35 +```
36 +
37 +### Install
38 +
39 +```sh
40 +npm install
41 +```
42 +
43 +### Run program
44 +
45 +If you modify your backend project and want to run the server for checking..
46 +
47 +```sh
48 +npm run dev:server
49 +```
50 +
51 +If you modify your frontend project and want to check the change on server..
52 +
53 +```sh
54 +npm run dev:assets
55 +```
56 +
57 +I just recommend run both at the same time.
58 +
59 +### Reference links
60 +
16 ## Pages: 61 ## Pages:
17 62
18 -- [ ] Home 63 +- [x] Home
19 - [x] Join 64 - [x] Join
20 - [x] Login 65 - [x] Login
21 - [x] Search 66 - [x] Search
22 -- [ ] User Detail 67 +- [x] User Detail
23 - [x] Edit Profile 68 - [x] Edit Profile
24 - [x] Change Password 69 - [x] Change Password
25 - [x] Upload 70 - [x] Upload
26 -- [ ] Video Detail 71 +- [x] Video Detail
27 - [x] Edit Video 72 - [x] Edit Video
......