Teamwork app

Description

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

Setup

• You need to have git, NodeJS and nmp installed on your local environment.
• Clone the application with git clone command.
• npm install to install all the dependencies in local environment.
• cp .env.example .env to have env setup
• Add values in .env file

Getting Started

Starting application run the following npm scripts

• npm run migrate for migrating tables.
• npm start for starting the server.

Testing

When you need to test the application and view test coverage run:

• npm test for running the tests, and getting coverage summary.

API

• POST /api/v2/auth/signup Creating account.

• POST /api/v2/auth/signin Sign in.

  Require authentication

• GET /api/v2/feeds Retrieve all articles posted

• GET /api/v2/feeds/:tagId/tags Retrieve articles by tag

• GET /api/v2/articles/:articleId Fetch single article by its ID

• GET /api/v2/author/articles/:authorId Fetch all articles by author ID

• POST /api/v2/articles Create new article

• POST /api/v2/:articleId/comments Add comment to an article

• PATCH /api/v2/articles/:articleId Update an article

• DELETE /api/v2/articles/:articleId Delete an article

Heroku

Access link :Visit the link.

Swagger API Documentation

Access link :Visit the link.

Github-page

GitHub page (gh-page) of this project accessed using this link Teamwork.