project-watchdog

project-watchdog copied to clipboard

Project Watchdog is a project managment system that helps students and adviosrs to collaborate on a project by tracking each step of their project phase. It has useful features like task assignment, progress report, project archive and project history.

See it in action

Project Watchdog YouTube

Getting Started

To get started with the project you need to install node and mongodb on your local machine.

Prerequisites

To get started clone the repo

git clone https://gitlab.com/rabira-hierpa/project_watchdog.git
cd project-watchdog/

Install dependencies

To install all the dependencies for both the backend and front-end

npm run install-all  #or
yarn run install-all

To get the development server started

npm start

Or you can do

git clone https://gitlab.com/rabira-hierpa/project_watchdog.git
cd project_watchdog/
npm install # or yarn start
npm start # starts the front-end 

To run the backend (express app)

git clone https://gitlab.com/rabira-hierpa/project_watchdog.git
cd project_watchdog/server
npm install # or yarn start
cp .env.example .env # you can change the REACT_APP_PUBLIC_URL to point to the port your backend is running 
npm start # starts the backend

Deployment

To deploy the app to your local server you can do

git clone https://gitlab.com/rabira-hierpa/project_watchdog.git
cd project-watchdog/
npm install #or yarn start
npm build

Built With

• React - The frontend UI framework used
• Yarn - Dependency Management
• react-chart-js - Used for drawing project charts
• Express - Used for building the RESTful API
• Passport - Used for user authentication

License

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

Acknowledgments

• TraversyMedia
• Acadaminde