Mentor-Management-System-Team-5

Mentors Management system is a people management app that enables proper. coordination of mentors needed to execute projects, ranging from recruitment to off-boarding. Ensure to go through the app doc below to read more and follow all the instructions.

Contributor's wiki

Techonologies

• Frontend
• Backend
• Database
• Deployment env

How to contributing to this project

To get it up and running on your local machine, follow the steps below:

• Fork this repo following this guideline.

• Clone the repo with the command `git clone`

• Indicate your interest to work on any issue. "eg. I want to work on this issue, or I am interested in this issue"

• Open a feature branch from the 'develop' branch. e.g. feat/

• Make sure the name describes your branch but is not too long. Lead with what the branch is doing, e.g. new feature or bug but follow this pattern type/branch-description eg feature/add-login-functionality.

• Ensure your branch is up to date with the latest changes before pushing

• Create a pull request against develop branch

• Reference the issue you worked on in your PR

• Open a pull request against the develop branch and request a review from your

Frontend

• Navigate to the project directory with the command cd Mentor-Management-System-Team-5

• Navigate to the frontend directory with the command cd frontend

• Navigate to the frontend directory with the command cd frontend mms-Admin

• Install all the dependencies with the command npm install

• Start the app with the command npm run dev

• Navigate to the app on your browser with the url http://localhost:**** where **** is the port number displayed on your terminal.

Backend

• Backend

Design

The design can be found here Find the Prototype here

Work on your Team assigned task, e.g. Team 1, Team 2 etc.

NOTE: Strictly adhere to the style guide on the design, buttons, texts etc.

Creating issue

Raise any identified issue with your mentor.

Other commands available

• npm run build - Builds the app for production to the dist folder.

• npm run lint - Lints the codebase.

• npm run lint:fix - Lints the codebase and fixes auto-fixable error.