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.
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
- UI
- Any Web Browser (We recommend using Google Chrome)
- Text Editor (We recommend using VSCode)
- API Endpoints
- Node JS
- Postman (For testing api locally)
- Simply Clone The project
- OR use git bash:
- First download git bash
- Install it
- Clone it by running
git clone https://github.com/hakoemmy/TeamWork.git - Find the project directory from where you are tunning the git bash.
1.For running the API
-
First download and install Node JS
-
Download and install Postman
-
Clone the project. TeamWork
-
Run
npm install(sudo apt installfor linux users) command for installing all project dependencies
- Open command prompt
- navigate to the directory of cloned project
- Run the automated test by running
npm run testcommand
-
Local
Run
npm run dev-start -
Live
The API enpoints are hosted on this URL link here
Just follow API documentation link for testing all API endpoints like so
-
Just run
index.htmlfrom the cloned project -
OR simply use ghpage to run TeamWork UI Template
-
Server
-
UI Templates
- CSS
- HTML
- JS
- Hosting service: gh-pages
- Fork it
- Create a branch (git checkout -b my_branch_name)
- Commit your changes (git commit -m "Added Some stuffs")
- Push to the branch (git push origin git checkout -b my_branch_name)
- Create an Issue with a link to your branch
This project is licensed under the MIT License - see the LICENSE file for details