Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rohhn/personal-mentoring-app
Final project code for CS 546, Stevens Institute of Technology
https://github.com/rohhn/personal-mentoring-app
Last synced: about 1 month ago
JSON representation
Final project code for CS 546, Stevens Institute of Technology
- Host: GitHub
- URL: https://github.com/rohhn/personal-mentoring-app
- Owner: rohhn
- Created: 2024-10-13T20:10:44.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-12-17T02:11:24.000Z (about 1 month ago)
- Last Synced: 2024-12-17T03:25:43.868Z (about 1 month ago)
- Language: JavaScript
- Size: 5.14 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CS546_TeamProject
Final project code for CS 546, Stevens Institute of Technology
GitHub Repository: [link](https://github.com/rohhn/Personal-Mentoring-App.git)
## Personal Mentoring Web App
### Proposed features
- User sign up/ login
- User management
- Features for Mentors
- Functionalities for Mentees
- Ratings and Review Mechanism
- Subject Specific Forums
- Digital Acheivement Badges
## Run Instructions
The database is hosted on MongoDB Atlas, it's pre-seeded.
All required environment secrets for third-party integrations are provided in the `.env` file.
To run:
- Install all required packages
```bash
npm i
```
- Run the app using
```
npm start
```
## Development
### GitHub
- `main` is a protected branch. No pushes are allowed on this branch.
- `dev` will be our main development branch. All merges from `feature` branches should merge to `dev` before going to `main`.
- To make changes:
- Clone the repository using `git clone`
- Switch to the dev branch using `git checkout dev`
- Pull all latest changes in the `dev` branch using `git pull`
- Create your own feature branch from the `dev` branch using `git checkout -b feature/{feature_name}`
- Push all your changes to your `feature` branch and create a pull request to the `dev` branch.
### Front-end setup
- Setup the required environment variables.
- Create a copy of the `env_template` file and rename it to `.env`
```shell
cp env_template .env
```
- Populate all values in the `.env` file.
You can use this [website](https://djecrety.ir/) to generate an express session secret token.