hakoemmy/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.

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.

Getting 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.

The project is composed of two different parts:

• UI (User Interface)
• API Endpoints

Prerequisites

• UI
  • Any Web Browser (We recommend using Google Chrome)
  • Text Editor (We recommend using VSCode)
• API Endpoints
  • Node JS
  • Postman (For testing api locally)

Cloning the project

• Simply Clone The project
• OR use git bash:
  1. First download git bash
  2. Install it
  3. Clone it by running git clone https://github.com/hakoemmy/TeamWork.git
  4. Find the project directory from where you are tunning the git bash.

Installing

1.For running the API

1. First download and install Node JS

2. Download and install Postman

3. Clone the project. TeamWork

4. Run npm install (sudo apt install for linux users) command for installing all project dependencies

Running the tests

1. Open command prompt
2. navigate to the directory of cloned project
3. Run the automated test by running npm run test command

Running API server

• Local

  Run npm run dev-start

• Live

  The API enpoints are hosted on this URL link here

API documentation

Just follow API documentation link for testing all API endpoints like so

Running the UI Template

• Just run index.html from the cloned project

• OR simply use ghpage to run TeamWork UI Template

Built With

• Server

  • Server side Framework: Node JS/Express
  • Linting Library: ESLint
  • Style Guide: Airbnb
  • Testing Framework: Mocha
  • Documentation Tools: Swagger
  • Database: Postgres
  • Hosting serice: Heroku

• UI Templates

  • CSS
  • HTML
  • JS
  • Hosting service: gh-pages

Contributing

1. Fork it
2. Create a branch (git checkout -b my_branch_name)
3. Commit your changes (git commit -m "Added Some stuffs")
4. Push to the branch (git push origin git checkout -b my_branch_name)
5. Create an Issue with a link to your branch

Author

Emmanuel HAKORIMANA

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

• Andela Kigali