Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/meenalsingh0/GradGather/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through getting a fully functional GradGather instance running on your local machine. By the end you will have the Express server started, a MongoDB database connected, and the BridgeU home page loading in your browser — ready for development or exploration.
1

Prerequisites

Make sure the following are available on your machine before you begin:
  • Node.js — nodejs.org/en/download
  • npm — bundled with Node.js
  • MongoDB — a local installation running on the default port (27017) is required; the connection string is hard-coded in src/mongo.js as mongodb://localhost:27017/LoginFormPractice
Verify your versions:
node --version
npm --version
mongod --version
2

Clone the repository

Clone the GradGather repository from GitHub and navigate into the project root:
git clone https://github.com/meenalsingh0/GradGather.git && cd GradGather
The project root contains src/ (server code), tempelates/ (Handlebars views), public/ (static assets), and package.json.
3

Install dependencies

Install all Node.js dependencies declared in package.json:
npm install
This pulls in the core packages the platform depends on:
PackagePurpose
expressHTTP server and routing
mongooseMongoDB ODM
hbsHandlebars view engine for Express
express-handlebarsExtended Handlebars integration
paypal-rest-sdkPayPal donation payment gateway
dotenvEnvironment variable loading
nodemonAuto-restart during development
4

Configure environment variables

Create a .env file in the project root. GradGather reads this file automatically via dotenv on startup:
# Server
PORT=3000

# PayPal REST SDK (required for the donation feature)
PAYPAL_MODE=sandbox
PAYPAL_CLIENT_KEY=your_paypal_client_id_here
PAYPAL_SECRET_KEY=your_paypal_secret_key_here
The MongoDB connection string is hard-coded directly in src/mongo.js as mongodb://localhost:27017/LoginFormPractice. It is not read from an environment variable. Make sure MongoDB is running locally on the default port before starting the server.
For PayPal credentials, create a REST app in the PayPal Developer Dashboard and copy the Client ID and Secret for the sandbox environment.
5

Start the server

You have two options depending on your workflow:Production / one-off run:
node src/index.js
Development (auto-restart on file changes):
nodemon src/index.js
Use nodemon src/index.js while developing. nodemon watches the project for file changes and automatically restarts the Express server, so you never have to stop and re-run the process manually after editing a template or route.
A successful startup prints two lines to the console:
mongoose connected
port connected
If you see failed instead of mongoose connected, check that your local MongoDB instance is running on port 27017.
6

Open in your browser

Navigate to http://localhost:3000 in your browser. You should see the BridgeU home page — a landing page with the BridgeU logo, a welcome message, and a Join Our Community call-to-action button that takes new visitors to the role-selection screen.From there you can explore the app through the following paths:
PathDescription
/BridgeU home page
/2signupRole selection (Student or Alumni)
/signupAccount registration form
/loginLogin form
/landingPost-login landing page
/dashboardUser dashboard
/studashStudent dashboard
/directoryAlumni directory
/eventsEvents listing
/clubsClubs listing
/connectConnection hub
/userprofileUser profile page
/stuprofileStudent profile page
/technoTechno page
/donationDonation page
/paymentGatewayPayment gateway page
/successPayment success page
/cancelPayment cancelled page

Build docs developers (and LLMs) love

Get started for freeTalk to us