Skip to content

Created a school management API system designed to manage school data, support location-based sorting, and provide seamless testing with integrated Postman collections.

Notifications You must be signed in to change notification settings

vishal7095/School-Management

Repository files navigation

School Management API

This project is a School Management API system designed to manage school data, sort schools by proximity based on user location, and facilitate seamless testing with integrated Postman collections. The system uses Node.js, Express.js, MySQL, and Geolib for geolocation-based sorting and CRUD operations for school data management.

Features

  • Add new schools to the database.
  • List schools sorted by proximity based on user latitude and longitude.
  • Ensure data validation and error handling for smooth user experience.
  • Integrated Postman collection for testing the APIs.

API Endpoints

  • POST /addSchool: Add a new school to the database.
  • GET /listSchools: Get schools sorted by proximity from the user's location.

Live API

Technologies

  • Node.js
  • Express.js
  • MySQL
  • Geolib
  • Postman (for API testing)

Setup

  1. Clone the repository: git clone <repo-link>
  2. Install dependencies: npm install
  3. Configure environment variables for MySQL in .env file.
  4. Run the server: npm start
  5. Access the API via http://localhost:3000

License

This project is licensed under the MIT License.

About

Created a school management API system designed to manage school data, support location-based sorting, and provide seamless testing with integrated Postman collections.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published