ZenScholar

A platform that supports university students struggling with depression, stress and anxiety.

System Documentation

Visit system documentation

Project Setup

Clone the repository

1. If you do not have git installed, install it here
2. Open your terminal/command prompt and run the following line: git clone https://github.com/Rajae-Robinson/ZenScholar.git

Installing Project Dependencies

1. Ensure that you have Node and NPM installed, see here
2. Open your terminal and navigate to the folder containing the project. For example, if you cloned the project to desktop run cd desktop/zen-scholar
3. Run npm install

Running the Project

1. If npm install ran without errors, then run npm run dev to start the local development server.
2. Open the website in your brower using the localhost link shown in your terminal. It is usually http://localhost:5173/

Contributing

1. Create a new branch using the latest changes from main.

   git branch <branch_name>
   git checkout <branch_name>

2. After adding and commiting desired changes push your branch to origin by running git push.

3. Go to Github's website, go to 'Pull Requests' tab, open pull request for branch, tag and notify reviewer.

Changes can only be merged after reviewer accepts PR.