# BUMCA Alumni Gathering Web Application
- Introduction
- Features
- Technology Stack
- Installation
- Usage
- Screenshots
- Contributing
- License
- Acknowledgments
The BUMCA Alumni Gathering Web Application is designed to facilitate engagement, networking, and resource sharing among the alumni, staff, and administration of Berhampur University's MCA program. This platform offers a range of features to support the alumni community, including user authentication, profile management, content creation, media sharing, commenting, and search functionality.
- User Authentication: Secure login and registration for alumni, staff, and admin.
- Profile Management: Update and manage personal profiles, including contact information, social links, and bio.
- Content Creation: Post updates, share job vacancies, and announce gatherings.
- Media Sharing: Upload and share images, videos, and documents.
- Commenting: Engage with posts through comments.
- Search Functionality: Search for alumni by name, passing year, or other criteria.
- Admin Controls: Manage users, posts, and carousel images; delete irrelevant content.
- Frontend: React.js
- Backend: Node.js with Express.js
- Database: MongoDB
- Development Tools: Visual Studio Code, Git, GitHub
- Other Technologies: HTML, CSS, JavaScript
-
Clone the repository:
git clone https://github.com/yourusername/BUMCA-Alumni-Gathering.git cd BUMCA-Alumni-Gathering
-
Install frontend dependencies:
Copy code cd client npm install cd ..
-
Install backend dependencies:
Copy code cd server npm install cd ..
-
Set up environment variables: Create a .env file in the server directory with the following contents:
Copy code MONGODB_URI=your_mongodb_uri JWT_SECRET=your_jwt_secret
-
Run the application:
Start the backend server:
bash Copy code cd server npm start **Start the frontend development server:**
bash
Copy code
cd client
npm start
6. Open your browser and navigate to:
```arduino
Copy code
http://localhost:3000
Usage Register an account as an alumni, staff, or admin. Log in to access your dashboard. Update your profile with personal information, social links, and bio. Create and share posts about job vacancies, gatherings, and other updates. Upload and share media files in the media section. Search for alumni by name, passing year, or other criteria. Admin users can manage content and users through the admin dashboard.
Contributions are welcome! Please read the CONTRIBUTING.md file for guidelines on how to contribute to this project.
We would like to thank the faculty and administration of Berhampur University, our team members, the alumni community, and the authors of the resources we used. Your support, feedback, and dedication were instrumental in bringing this project to life.
- Screenshots: Ensure you have relevant screenshots saved in a
screenshots
directory within your project. Update the image paths accordingly. - Environment Variables: Replace
your_mongodb_uri
andyour_jwt_secret
with your actual MongoDB URI and JWT secret. - GitHub Repository URL: Replace
https://github.com/yourusername/BUMCA-Alumni-Gathering.git
with the actual URL of your GitHub repository. - Contributing Guidelines: Create a
CONTRIBUTING.md
file with guidelines on how others can contribute to your project. - License: Ensure the
LICENSE
file is included in your project root with the appropriate license text.
This README.md
file provides a comprehensive overview of your project, including setup instructions, usage details, and contribution guidelines, making it easier for others to understand and contribute to your project.