Design Link

https://www.figma.com/file/1g4KeJKgyaBYHKD2lJnJw6/Result-Manager-Project?node-id=0%3A1

Result-Tracker

This is a progressive web application which enables university students to calculate and keep track of their results for future references.

Welcome, and thank you for contributing to this project. Please take your time to study this document carefully before making any changes to the codebase, to ensure you're on the same page with the rest of the team and we can all collaborate seamlessly.

Set up and Contribution

To set up this project, first fork this repositiory to your own account

Locate fork button and click on it.

Then go to your desktop and create a folder, name it ResultManager.

Open the folder (ResultManager), right click and select the option gitbash here (ensure you have git installed).

Then run all the commands in the git terminal that will open.

Make the folder a git folder by running the following command

git init

Set up your origin and upstream remotes by running the following commands

git remote add origin https://github.com/{YOUR-GITHUB-USERNAME}/ResultManager.git

git remote add upstream https://github.com/dscimsu/OnlineResultChecker.git

Pull the code to Your project directory and set it up by running the following command

git fetch upstream
git checkout develop

To install the dependencies the app is using run the command (ensure you have node installed)

npm install

DATABASE SETUP

We are using MongoDb which is a noSql database

Follow the link below to download and install MongoDb server(MSI VERSION)

https://www.mongodb.com/download-center/community

Follow the link below to download and install MongoDb Compass

https://www.mongodb.com/download-center/compass

After installation

Go to your root folder and create a new file and save it as

.env

Copy the content of the .env.example file and paste it inside the .env file you created

PROFILE IMAGE UPLOAD SETUP

We are using cloudinary api to upload our images to cloudinary

Follow the link below to create and account and obtain your own Api keys

https://cloudinary.com

After creating an account take your Api keys and fill the empty keys in the .env file.

To start the application on your localhost run the command

  npm install nodemon -g

Then start your app using nodemon

nodemon

// Then go to your browser and and type http://localhost:8000/

After contributing based on a specified issue, run the following commands after commiting changes
```bash
git pull upstream
git push origin develop

Then from your develop branch you can create a pull request to dscimsu develop branch,

Please ensure your pull request is working as intended, before you make it.

Thanks for contributing.