Skip to content

Latest commit

 

History

History
54 lines (41 loc) · 1.63 KB

README.md

File metadata and controls

54 lines (41 loc) · 1.63 KB

Kung-Fu Lighting Backend

This repository contains the backend service for the Kung-Fu Lighting project, handling API requests, profile storage, and user authentication for the ChromaProfiles Gallery. It is built using Node.js and Express, with a focus on performance and scalability.

Features

  • RESTful API: Provides endpoints for managing RGB lighting profiles.
  • User Authentication: Secure login via Reddit 0Auth2.
  • Profile Management: Create, update, and delete lighting profiles.
  • Database Integration: Utilizes MongoDB (or other databases) for profile storage.
  • Error Handling: Centralized error handling and validation mechanisms.

Installation

  1. Clone the repository:

    git clone https://github.com/TheSylvester/Kung-Fu-Lighting-backend.git

  2. Navigate to the project directory:

    cd kung-fu-lighting-backend

  3. Install dependencies:

    npm install

  4. Create a .env file in the root directory and add the necessary environment variables:

    MONGODB_URI=your_mongodb_connection_string
JWT_SECRET=your_jwt_secret

  5. Start the server:

    npm start

API Endpoints

  • GET /profiles: Fetch all available RGB lighting profiles.
  • POST /profiles: Create a new profile.
  • PUT /profiles/:id: Update a profile by ID.
  • DELETE /profiles/:id: Delete a profile by ID.
  • POST /auth/login: User login.
  • POST /auth/register: User registration.

Contributing

Feel free to submit issues or contribute to the project via pull requests.

License

This project is licensed under the GPL-3.0 License.