Skip to content
This repository has been archived by the owner on Jul 18, 2022. It is now read-only.

Sunrinlifeteam/Sunrinlife_Back_v1

Repository files navigation

SunrinLife REST API

RESTful API for SunrinLife
SunrinLife is designed to integrate your school's various services into one convenient location.


Fueled by Sunrin Internet High School Students with ❤️
Report an Issue

Why Use SunrinLife?

Integration

Many schools have discrete services created by multiple people. While this might sound not so bad, multiple individual services scattered around the web causes services to be less accessible. This is where SunrinLife comes in. SunrinLife integrates various services into one convenient location, making using services more accessible, easier, and faster.

Extensible, unbeatable scalability

Customize your service with ease! With SunrinLife, you can create various extensions easier than ever before. SunrinLife's modularized design fully takes advantage of scalability, stability, and customizability.

🛠️ Installation

$ yarn

🚀 Running the app

# development
$ yarn dev

# production mode
$ yarn start

🔒 Environment configuration

NODE_ENV
# Enter development for Development, production for Production Service

DB_NAME
DB_PORT
DB_HOST
DB_USERNAME
DB_PASSWORD

UPLOAD_TEMP_PATH
UPLOAD_PATH

ATPT_OFCDC_SC_CODE
SD_SCHUL_CODE

SESSION_SECRET

UPLOAD_TEMP_PATH
UPLOAD_PATH

ATPT_OFCDC_SC_CODE
SD_SCHUL_CODE

SESSION_SECRET

NEIS_API_KEY

GOOGLE_CLIENT_ID
GOOGLE_CLIENT_SECRET
GOOGLE_CALLBACK_URL

GOOGLE_CLIENT_ID
GOOGLE_CLIENT_SECRET
GOOGLE_CALLBACK_URL
# Please Refer: https://developers.google.com/identity/protocols/oauth2

ACCESS_TOKEN_SECRET
ACCESS_TOKEN_EXPIRES_IN

REFRESH_TOKEN_SECRET
ACCESS_TOKEN_EXPIRES_IN

SERVICE_DOMAIN
SERVICE_PORT
FRONTEND_URL

REDIS_URL
# Format: redis[s]://[[username]][:password]@[host][:port][/db-number]