/Find-Bootcamp-App-backend

Primary LanguageJavaScript

Bootcamp and Online Courses API

Welcome to the Bootcamp and Online Courses API! This API serves as the backend for a web application that helps users discover and explore various bootcamps and online courses. Whether you are a student looking to enhance your skills or a professional seeking to upskill, this API provides a centralized platform for accessing information about relevant programs.

Table of Contents

Getting Started

Prerequisites

  • Node.js
  • MongoDB (or a MongoDB Atlas account)

Installation

  1. Clone the repository: git clone https://github.com/yourusername/bootcamp-api.git
  2. Navigate to the project directory: cd bootcamp-api
  3. Install dependencies: npm install

Running the API

  1. Set up a .env file with your MongoDB connection string and any other required variables.
  2. Start the server: npm start
  3. The API will be accessible at http://localhost:3000.

API Endpoints

List of Bootcamps

  • Endpoint: /api/bootcamps
  • Method: GET
  • Description: Get a list of all available bootcamps.

Details of a Bootcamp

  • Endpoint: /api/bootcamps/:id
  • Method: GET
  • Description: Get details of a specific bootcamp by ID.

Search Bootcamps

  • Endpoint: /api/bootcamps/search
  • Method: GET
  • Description: Search for bootcamps based on various criteria such as location, rating, and more.

List of Online Courses

  • Endpoint: /api/courses
  • Method: GET
  • Description: Get a list of all available online courses.

Details of an Online Course

  • Endpoint: /api/courses/:id
  • Method: GET
  • Description: Get details of a specific online course by ID.

Search Online Courses

  • Endpoint: /api/courses/search
  • Method: GET
  • Description: Search for online courses based on various criteria such as topic, duration, and more.

Authentication

To access certain endpoints, authentication is required. Include the authentication token in the request headers.

Error Handling

The API returns standard HTTP status codes for success and error responses. Details of errors are included in the response body.

Subject to Change

Please note that this API is under active development, and certain features, endpoints, or functionality may be subject to change in future releases. Keep an eye on our updates for the latest improvements.

Contribution

Contributions are welcome! If you have any suggestions, bug reports, or feature requests, feel free to create an issue or submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.