College API

Welcome to the College API! This API showcases a collection of undergraduate engineering colleges in India that are approved by the All India Council for Technical Education (AICTE) along with their respective states.

Getting Started

To use this API locally or deploy it, follow these steps:

Prerequisites

• Node.js (14.x recommended)
• MongoDB (Make sure you have a running MongoDB instance)

Installation

1. Fork and clone this repository to your local machine.

2. Open a terminal and navigate to the backend directory:

cd backend

3. Install the required dependencies:

npm install

Configuration

1. Create a .env file in the backend directory:

MONGODB_URL=your_mongodb_url_here

Replace your_mongodb_url_here with the actual MongoDB connection URL.

Running the Server

1. Start the backend server

npm start

The server will be accessible at http://localhost:8000.

2. To view the list of colleges, open a web browser or use a tool like Postman and navigate to:

http://localhost:8000/api/colleges

Usage

1. Use the /api/colleges endpoint to get a list of all colleges.

2. Use the /api/states endpoint to get a list of all states.

3. You can filter colleges based on states by appending ?state=state_name to the /api/colleges endpoint.

Contributing

1. Fork this repository.
2. Create a new branch for your feature:

git checkout -b feature/your-feature-name

3. Commit and push your changes to your branch.
4. Create a pull request to merge your changes into the main repository.