Code Monkey home page Code Monkey logo

teamwork's Introduction

Build Status Coverage Status Maintainability

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

Supporting Packages

Linter

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

Credit

teamwork's People

Contributors

banobepascal avatar

Stargazers

Perez Chris avatar Jamiu Ismail avatar Alimi Kehinde Morufudeen avatar  avatar jenny kibiri avatar Francis avatar  avatar  avatar

Watchers

James Cloos avatar  avatar Francis avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.