Bam92 / teamwork

Teamwork is an ​ internal social network for organizations’ employees

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 boarding

Links

• Front end
• Back end
• Documentation
• User stories

Get Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Here are the environment prerequisites for the web app

• NodeJS at least v10

Installing

Make sure you have yarn installed already (yarn --version to test) Clone the repository

• Run yarn install to install packages
• Run yarn start to start the server

Running the tests

yarn test

API endpoints

Make sure you have Postman or other tool that can handle http request. Please refer to the docs for more explanation. For base url refer to back end link

GET

• feeds
• /articles/categories/:id
• /articles/:id

POST

• auth/signup
• auth/signin
• articles
• articles/:id/comments
• articles/:id/flag
• comments/:id/flag

PATCH

• articles/:id

DELETE

• articles/:id

Endpoint	Method	Functionality
auth/signin	POST	Login registered employee
auth/signup	POST	Register a new employee
articles	POST	Create an article
feeds	GET	Get list of all articles
articles/<:articleId>	GET	Get a specific article
articles/<:articleId>	PATCH	Update a specific article
articles/<:articleId>	DELETE	Delete a specific article
articles/<:articleId>/comments	POST	Post a comment on a specific article
articles/categories/<:categoryId>	GET	Filter articles by category
articles/<:articleId>/flag	POST	Flag an article
articles/<:commentId>/flag	POST	Flag a comment

Built with

• HTML
• CSS
• Javascript
• NodeJS / Express

Versioning

We use SemVer for versioning.

Author

Abel L Mbula

• https://twitter.com/abelmbula

Copyright and license

Code and documentation copyright 2019 Abel and Andela. Code released under the MIT License. Docs released under Creative Commons.