README.md

Pudding (server)

Global Project Funding Service

✋Team Members

• 
• 
• 
• 

---

🧞Quick Start

1. Clone & Install Packages

git clone https://github.com/siliconValleyTeamA/server.git
cd server
npm install

2. Add config.json / secret.json / auth.json in server

1. add cofing.json in db folder

confing.json
{
    "host": “${serverIP}”,
    "user": “${dbUser}”,
    "password”: “${dbPassword}”,
    "database": “${dbName}”
}

2. add secret.json in root folder

secret.json
{
    "SECRET_KEY": “${loginKEY}”
}

3. add auth.json in root folder

auth.json
{
    "CLIENT_ID": "${githubPassPortID}",
    "CLIENT_SECRET": "${githubPassPortID}",
    "CALLBACK_URL": "${githubCallbackURL}"
}

4. add s3config.json in route folder

auth.json
{
    "accessKeyId": "${S3accessKeyId}",
    "secretAccessKey": "${S3secretAccessKey}",
    "region": "${S3region}"
}

3. Run develop server

npm run dev

Then, you can access to your server http://localhost:8080

---

API - Swagger

---

기술 스택

Backend

• 
• 
• 

ETC

• 
• 
• 

---

프로젝트 구조

|-- server // Backend
    |-- bin
    |   |-- www
    |
    |-- public
    |   |-- docs
    |   |   ... // 스웨거 관련 파일
    |   |
    |   |-- swagger.yaml
    |
    |-- db
    |   ... // 데이터베이스 작업 처리(config.json 위치)
    |
    |-- routes
    |   ... // 라우터 요청에 따른 작업 처리(s3config.json 위치)
    |
    |-- views
    |   ...  // pug 파일
    |
    |-- app.js
    |-- auth.json
    |-- secret.json