greenlight

module
v0.0.0-...-8a2e13d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 9, 2024 License: MIT

README

Greenlight - Movie Information Management API

Greenlight is an API designed for retrieving and managing information about movies. Inspired by the Open Movie Database API, Greenlight offers a comprehensive set of endpoints to cater to various functionalities related to movie data. Whether you need to retrieve details about all movies, create a new movie entry, update movie information, or manage user authentication, Greenlight has got you covered.

Features

  • Health Check Endpoint: Assess the application's health and retrieve version information.
  • Movies Endpoint: Interact with movie data, including listing, creating, updating, and deleting movies.
  • User Management Endpoint: Handle user-related actions, including registration, activation, password update, and token generation.
  • Token Management Endpoint: Generate authentication and password-reset tokens.
  • Metrics Endpoint: Display application metrics for debugging purposes.

Getting Started

To get started with Greenlight API, follow these steps:

  1. Clone the repository: git clone https://github.com/amdzy/greenlight-api.git
  2. Install dependencies: npm install
  3. Configure the environment variables.
  4. Run the application: npm start

License

This project is licensed under the MIT License.

Directories

Path Synopsis
cmd
api command
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL