Teamwork

Teamwork is an internal social network for employees of an organisation. The goal of this application is to facilitate more interaction between colleagues and promote team bonding

Github Project Card

Project is currently being built with the Project Management Tool; Github Project. You can find the stories at https://github.com/an-apluss/teamwork/projects/1

API Deployment

API deployment URL - https://web-teamwork.herokuapp.com

API Documentation

API documentation URL - https://web-teamwork.herokuapp.com/documentation

Built With

• NodeJS
• ExpressJS
• PostgreSQL
• Cloundinary
• JavaScript

Getting Started

Installation

• Clone this repository using git clone https://github.com/an-apluss/teamwork.git .
• Use the .env.example file to setup your environment variables and rename the file to .env
• Run npm install to install all dependencies
• Run npm start to start the server

Supporting Packages

Linter

• ESLint - Linter Tool

Compiler

• Babel - Compiler for Next Generation JavaScript

Test Tools

• Mocha - JavaScript Test Framework for API Tests (Backend)
• Chai - TDD/BDD Assertion Library for Node
• Chai-http - A Chai plugin for testing node.js HTTP servers
• Istanbul(nyc) - Code Coverage Generator

• Run Test

npm test

• Run Coverage Report

npm run coverage

API Routes

DESCRIPTION	HTTP METHOD	ROUTES
Create user account	POST	/api/v1/auth/create-user
Login a user	POST	/api/v1/auth/signin
Create a gif	POST	/api/v1/gifs
Create an article	POST	/api/v1/articles
Edit an article	PATCH	/api/v1/articles/<:articleId>
Employees can delete their articles	DELETE	/api/v1/articles/<:articleId>
Employees can delete their gifs	DELETE	/api/v1/gifs/<:gifId>
Employees can comment on other colleagues'
article post	POST	/api/v1/articles/<:articleId>/comment
Employees can comment on other colleagues'
gif post	POST	/api/v1/gifs/<:gifId>/comment
Employees can view all articles or gifs,
showing the most recently posted articles
or gifs first	GET	/api/v1/feed
Employees can view a specific article	GET	/api/v1/articles/<:articleId>
Employees can view a specific gif	GET	/api/v1/gifs/<:gifId>

Project References

• I learnt how to structure my project from a video tuturial by Bolaji Olajide - https://www.youtube.com/watch?v=WLIqvJzD9DE
• I learnt how to used bycrpt and jwt dependencies and how to capture the big picture of an application before writing code, from a video course created by Will Alexander - Go Full-Stack With Node.js, Express, and MongoDB | https://openclassrooms.com/en/courses/5614116-go-full-stack-with-node-js-express-and-mongodb
• I learnt how to persist data into database with nodejs from an article curated by Olawale Aladeusi - Building a simple API with Nodejs, Expressjs and PostgreSQL DB - 2 | https://www.codementor.io/olawalealadeusi896/building-a-simple-api-with-nodejs-expressjs-and-postgresql-db-masuu56t7
• Stackoverflow was also a blessing whenever I come across question I can't answer
• Google

License

© Anuoluwapo Akinseye

Licensed under the MIT License