/teamwork-api

A social application to for employees to share images and articles (Api)

Primary LanguageJavaScript

Build Status Coverage Status Maintainability

teamwork-api

DevCTrainingWithAndela Capstone project (Api Endpoints)

clone project

$ git clone https://github.com/wincodes/teamwork-api.git

cd into the project folder

$ cd teamwork-api

install dependencies

$ npm install

set up

  • copy cotents of .env.example to a new .env file and set all your env variables
  • after setting your database variables, run $ npm run migrate to run database migrations

start the development server

$ npm run server

run tests

$ npm run test

api documentation

visit /api/v1/api-docs for the api documentation