Giter Club home page Giter Club logo

teamwork's Introduction

Teamwork: Andela Developer Challenge

Maintainability Build Status Coverage Status

Table of contents

General Info

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.

Technologies Used

  • HTML5
  • CSS3
  • NodeJS
  • Express
  • ES6

Setup

  • clone the repository using git clone https://github.com/kwizeraelvis/teamwork.git
  • Move into project directory using cd teamwork
  • Install neccesary packages using npm install
  • Build the source using npm run build
  • Start the server using npm run start
  • Interface the API using postman or any other http client

Features

  • User can create an account
  • User can login
  • User can post/create an article
  • User can update his/her article
  • User can delete his/her article
  • User can view all available articles on the platform

Endpoints

Endpoint Method Functionalities
/auth/signup POST Create user account
/auth/signin POST Sigin into account
/articles POST Create a new article
/article/:article_id PUT Edit a particular article
/articles/:article_id DELETE Delete an article
/feeds GET Get all available articles
/feed/me GET Get all the articles for the current user
/articles/:articleId/comments POST Create/Post a comment

Documentation

The API documentation can be found at : https://documenter.getpostman.com/view/5540374/SVfWMRjc

Templates

The UI Templates can be found at : https://kwizeraelvis.github.io/teamwork/UI

Status

The project is stalled

Shoutouts

  1. Rukundo Eric
  2. Amily Kasim

Licence

License: MIT

  • Copyright (c) Kwizera Aime Elvis

teamwork's People

Contributors

kwizeraelvis avatar dependabot[bot] avatar snyk-bot avatar

Stargazers

Ahmed Akremi avatar

Watchers

James Cloos avatar  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.