Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 781 Bytes

README.md

File metadata and controls

27 lines (18 loc) · 781 Bytes

OSSU API

Open Source Society University API server

Install the server

Take a look at INSTALLING.md

Configure environment

Take a look at .envsample and rename it to .env. Edit the values according to your environment (please do not bring .env into source control)

Start the server

npm start

Test an api route

curl localhost:PORT/api/sample

Project Structure

  • /api/index.js is the base api file, from here, we load models.
  • /auth/index.js will be the authentication api file. Add auth strategies to files in thie /auth folder
  • /models is the folder for individual model files

Contribute

Check out the dev board for todo lists. link