AlumConnect is a dynamic web platform designed to strengthen alumni relationships by connecting former students with their alma mater. Built for the Smart India Hackathon 2024 (SIH 2024), this platform focuses on fostering collaboration, networking, and resource-sharing among alumni and students.
AlumConnect enables alumni to stay engaged with their institution through features such as event notifications, mentoring opportunities, and a job portal. Students and alumni can connect in meaningful ways, creating a vibrant and supportive community.
- User Authentication: Secure login for alumni, students, and administrators.
- Alumni Directory: A searchable list of alumni with profiles including professional and academic details.
- Event Management: View and register for alumni events and webinars.
- Job Portal: Post and apply for job opportunities within the network.
- Mentorship Program: Facilitate mentor-mentee connections.
- Real-time Chat: Communicate with other users via integrated messaging.
- Notifications: Stay updated with important announcements and messages.
- HTML5, CSS3, JavaScript
- React.js
- Node.js
- Express.js
- RESTful APIs for data handling
- MongoDB
- Authentication: JWT (JSON Web Tokens)
- Cloud Hosting: AWS / Heroku
- Version Control: Git & GitHub
Make sure you have the following installed on your system:
- Node.js (v16.x or above)
- npm or yarn
- MongoDB (local installation or MongoDB Atlas account)
- Git
-
Clone the repository:
git clone https://github.com/agastya3636/SIH2024.git cd SIH2024 -
Install dependencies:
# Install backend dependencies npm install # If frontend is separate, navigate to frontend directory cd client npm install cd ..
-
Environment Configuration: Create a
.envfile in the root directory and add the following variables:# Server Configuration PORT=5000 NODE_ENV=development # Database MONGODB_URI=mongodb://localhost:27017/alumconnect # Or for MongoDB Atlas: # MONGODB_URI=mongodb+srv://<username>:<password>@cluster.mongodb.net/alumconnect # JWT Secret JWT_SECRET=your_jwt_secret_key_here JWT_EXPIRE=7d # Email Configuration (optional) EMAIL_HOST=smtp.gmail.com EMAIL_PORT=587 EMAIL_USER=your_email@example.com EMAIL_PASSWORD=your_email_password # Frontend URL CLIENT_URL=http://localhost:3000
-
Database Setup:
# Make sure MongoDB is running locally # Or use MongoDB Atlas connection string # Run database migrations/seeders if available npm run seed
-
Start the application:
# Development mode (backend) npm run dev # In a separate terminal, start frontend (if separate) cd client npm start
-
Access the application:
- Frontend:
http://localhost:3000 - Backend API:
http://localhost:5000
- Frontend:
To make testing easier, here are some pre-seeded dummy accounts you can use:
{
"email": "alumni@example.com",
"password": "alumni123",
"name": "John Doe",
"batch": "2018",
"role": "alumni"
}{
"email": "student@example.com",
"password": "student123",
"name": "Jane Smith",
"batch": "2024",
"role": "student"
}{
"email": "admin@example.com",
"password": "admin123",
"name": "Admin User",
"role": "admin"
}AlumConnect/
├── client/ # Frontend React application
│ ├── public/
│ ├── src/
│ │ ├── components/ # React components
│ │ ├── pages/ # Page components
│ │ ├── services/ # API services
│ │ ├── utils/ # Utility functions
│ │ └── App.js
│ └── package.json
├── server/ # Backend application
│ ├── config/ # Configuration files
│ ├── controllers/ # Route controllers
│ ├── models/ # Database models
│ ├── routes/ # API routes
│ ├── middleware/ # Custom middleware
│ ├── utils/ # Helper functions
│ └── server.js
├── .env # Environment variables
├── .gitignore
├── package.json
└── README.md
We welcome contributions from the community! Here's how you can help:
-
Fork the repository
# Click the 'Fork' button on GitHub -
Clone your fork
git clone https://github.com/your-username/AlumConnect.git cd SIH2024 -
Create a new branch
git checkout -b feature/your-feature-name # or git checkout -b fix/your-bug-fix -
Make your changes
- Write clean, maintainable code
- Follow the existing code style
- Add comments where necessary
- Update documentation if needed
-
Test your changes
npm test -
Commit your changes
git add . git commit -m "Add: brief description of your changes"
Commit Message Guidelines:
Add:for new featuresFix:for bug fixesUpdate:for updates to existing featuresRemove:for removing code or filesDocs:for documentation changes
-
Push to your fork
git push origin feature/your-feature-name
-
Create a Pull Request
- Go to the original repository on GitHub
- Click "New Pull Request"
- Select your fork and branch
- Provide a clear description of your changes
- Link any related issues
- Code Style: Follow the existing code style and conventions
- Testing: Ensure all tests pass before submitting a PR
- Documentation: Update README and code comments as needed
- Commits: Write clear, concise commit messages
- Issues: Check existing issues before creating new ones
- Pull Requests: One feature/fix per PR for easier review
- Be respectful and inclusive
- Provide constructive feedback
- Focus on what is best for the community
- Show empathy towards other community members
This project is licensed under the MIT License - see the LICENSE file for details.
- Project Lead: Agastya
- Repository: github.com/agastya3636/AlumConnect
- GitHub Issues: Report bugs or request features
- Email : agastyayadav2003@gmail.com
- Smart India Hackathon 2024 for providing the opportunity
- All contributors who have helped shape this project
- Open source community for the tools and libraries
This project was developed for Smart India Hackathon 2024. Active development and maintenance are ongoing.
Current Version: 1.0.0
Made with ❤️ by Agastya and Team