Skip to content

SOURAV-ROY/apiNodeJS

Repository files navigation

NodeJs API

Backend API for the DevCamper application to manage bootcamps, courses, reviews, and users.

Documentation

The documentation has been split into several files for better organization:

  • System Design: Comprehensive system architecture, design patterns, and technical overview of the project.
  • Setup and Configuration: Instructions on how to install, configure, and run the project.
  • API Reference: Detailed documentation of all API endpoints, including request/response examples.
  • Project Structure: Explanation of the codebase organization and key directories.
  • Project Flow: Request lifecycle and data flow diagrams.

Key Features

  • Bootcamps: Create, read, update, and delete bootcamps.
  • Courses: Manage courses associated with bootcamps.
  • Reviews: Users can review bootcamps.
  • Users & Authentication:
    • JWT/Cookie based authentication.
    • User roles (User, Publisher, Admin).
    • Password reset and update profile.
  • Geocoding: Calculate location and radius for bootcamps.
  • File Upload: Upload photos for bootcamps.
  • Security:
    • Password encryption.
    • Rate limiting.
    • NoSQL injection protection.
    • XSS protection.
    • HPP protection.
    • CORS enabled.

Quick Start

  1. Clone the repo.
  2. Install dependencies: npm install.
  3. Set up config/config.env (see Setup Guide).
  4. Run dev server: npm run dev.

License

ISC

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •