CampusNest is a full-stack web application for discovering, reviewing, and ranking university dorms. Students can search for dorms, read and write reviews, and explore amenities to make informed housing decisions.
- User registration and authentication
- Search and filter dorms by university, location, and amenities
- Add, edit, and delete reviews for dorms
- Star ratings and review counts
- User profile with editable info and profile photo
- Admin features (optional)
- Responsive, modern UI
- Frontend: React, CSS Modules
- Backend: Node.js, Express
- Database: MongoDB
- Authentication: JWT
- Node.js (v16+ recommended)
- npm or yarn
- MongoDB (local or Atlas)
- Clone the repository:
git clone https://github.com/yozanSAN/campusNest.git cd campusNest - Install backend dependencies:
cd backend npm install - Install frontend dependencies:
cd ../frontend npm install
Create a .env file in the backend/ directory with the following:
MONGO_URI=your_mongodb_connection_string
PORT=5000
JWT_SECRET=your_jwt_secret
BASE_URL=http://localhost:5000
- Start the backend:
cd backend npm run dev - Start the frontend:
cd ../frontend npm start - Visit http://localhost:3000 in your browser.
- Register a new account or log in.
- Search for dorms, view details, and read reviews.
- Add your own reviews and rate dorms.
- Edit your profile and upload a profile photo.
- You can use the provided scripts in the
scripts/folder to seed dorms and reviews for testing. - Example:
mongosh campusnest scripts/seedDormReviews.js
Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.
- Fork the repo
- Create your feature branch (
git checkout -b feature/YourFeature) - Commit your changes (
git commit -m 'Add some feature') - Push to the branch (
git push origin feature/YourFeature) - Open a pull request
CampusNest — Helping students find their perfect college dorm through honest reviews and detailed information.