Teamwork

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

Built With

• NodeJS - Runtime Environment
• ExpressJs - Web Application Framework

Supporting Packages

Linter

• ESLint - Linting Tool

Installation/Getting Started

• Git clone repository

git clone <repo_url>

• Install all dependencies

npm install

Running

npm start

Testing

Testing with Postman

* Install and setup Postman 
* Navigate to localhost 3000 

Features

• Users can create their own user account.
• Employees can sign in.
• Employees can write and/or share articles with colleagues on topics of interest to them.
• Employees can edit their articles.
• Employees can delete their articles.
• Employees can comment on other colleagues' article post.
• Employees can view all articles showing the most recently posted articles first.
• Employees can view a specific article.
• Employees can view all articles that belong to a category (tag).
• Employees can flag a comment, or article as inappropriate.
• Admin can delete a comment, or article flagged as inappropriate.

Endpoints

Method	Endpoint	Task
POST	/api/v2/auth/signup	User signup
POST	/api/v2/auth/signin	User login
GET	/api/v2/feeds	User view all articles posted
POST	/api/v2/articles	User post an article
PATCH	/api/v2/articles/:id	User edit article
GET	/api/v2/articles/:id	User can view specific
POST	/api/v2/articles/:id/comments	User can comment on specific article
DELETE	/api/v2/articles/:id	User can delete specific article
POST	/api/v2/articles/:id	User flag article as inappropiate
GET	api/v2/articles/tag/<keyword>	User can view articles based on tag/keyword

Deployments

• Frontend on Github
• Backend on Heroku
• Tracker on Pivotal Tracker
• Documentation on Postman

Credit

• All credit given to Andela