Welcome to the CampusGo Admission Portal's server-side code. This backend application is built with Node.js and Express.js, providing API endpoints for managing university admissions and related operations.
The CampusGo Admission Portal server uses the following technologies:
- Node.js: A JavaScript runtime environment for executing server-side code.
- Express.js: A fast and minimalist web application framework for Node.js.
- MongoDB: A NoSQL database for storing and managing data related to colleges and user applications.
- Firebase Authentication: A secure and reliable authentication service for user registration and login.
- Cloudinary: A cloud-based media management platform for storing and serving college images.
To run the CampusGo Admission Portal server locally on your machine, follow these steps:
- Clone the repository:
git clone [repository URL]
- Install dependencies:
npm install
- Set up the environment variables for database connection, authentication, and Cloudinary integration.
- Start the server:
npm run dev
- The server will start running on
http://localhost:5000
.
Ensure you have the latest version of Node.js and MongoDB installed.
The CampusGo Admission Portal server exposes the following API endpoints:
GET /college
: Retrieve details of all colleges.GET /college/:id
: Retrieve details of a specific college.GET /apply/:id
: Retrieve application details for a specific college.GET /apply
: Retrieve all user applications.POST /apply
: Submit a new user application.DELETE /apply/:id
: Delete a user application.
For detailed request/response formats, refer to the API documentation or codebase.
The CampusGo Admission Portal server can be deployed using platforms like Vercel. Utilize the provided vercel.json
configuration file for smooth deployment. Configure environment variables appropriately for production.
Contributions to the CampusGo Admission Portal project are encouraged! Feel free to submit pull requests for bug fixes, features, or enhancements. For significant changes, start by opening an issue to discuss the proposed changes.
This project is licensed under the MIT License.
For inquiries or feedback, please contact CampusGo Support.
This README file provides an overview of the server application, installation instructions, API documentation, technologies used, contributing guidelines, and contact information. Customize it further to match your specific project requirements.
If you need further assistance, don't hesitate to reach out!