Teamwork is an internal social network for organizations’ employees. The goal of this application is to facilitate more interaction between colleagues and facilitate team bonding.
HTML
CSS
Javascript
Javascript
NodeJS (Run-time environment for running JS codes)
Express
Mocha, Chai
Airbnb
Travis CI
Code Climate
Heroku
| Enpoint | Methods | Description |
|---|---|---|
| /api/v1/auth/signup | POST | Signup |
| /api/v1/auth/signin | POST | login |
| /api/v1/articles | POST | create new article |
| /api/v1/articles | GET | view all article |
| /api/v1/articles/:id | PATCH | update article |
| /api/v1/articles/:id | GET | view a specific article |
| /api/v1/articles/:id | DELETE | Delete an article |
| /api/v1/articles/:tag/category | GET | view by category |
| /api/v1/articles/:id/flag | GET | flag an article |
| /api/v1/articles/:id/comments | POST | create a comment |
{ "status": 200, "data": { ... } }
{ "status": 400, "message": "error-message" }
These instructions will get you a copy of the project up and running on your local machine or server for development and testing purposes. Here are deployment notes on how to deploy the project on a live system.
To install the software on your local machine or server, you need first to clone the repository or download the zip file and once this is set up you are going to need to install NodeJS.
The installation of this application is fairly straightforward, After cloning this repository to your local machine,CD into the package folder using your terminal and run the following
> npm install
It will install the node_modules which will help you run the project on your local machine.
> npm start
> npm test
© BLAISE Irakoze