Git Product home page Git Product logo

college-api's Introduction

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
  1. 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.

  1. 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
  1. Commit and push your changes to your branch.
  2. Create a pull request to merge your changes into the main repository.

college-api's People

Contributors

sshiwangi avatar

Stargazers

Sumanth avatar Sayak Bhunia avatar Pushkar Roy avatar Tobiloba Adedeji avatar

Watchers

 avatar

Forkers

vedantndasgupta

college-api's Issues

What's the source and when it was last updated?

Have you used any API provided by AICTE or any other organization? it seems like you stored all the details in your DB and retrieved it!!!
please reply with where you got the source, and how you're using it..........it will be helpful for me to work on my hackathon project(SIH-2k23)

Still Working?

does it has abitlity o filkter unvieristy on statewise

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.