🖼️ Recomend API

Recomend API

The main NestJS (with Fastify)-based API service for the Recomend application. It handles search functionalities for movies, TV series, persons, users, and playlists, alongside user authentication and other backend operations. Developed by @lxup.

🚀 Tech Stack

• ⚡️ NestJS – A progressive Node.js framework for building efficient, reliable and scalable server-side applications.
• 🚀 Fastify – Fast and low overhead web framework, for Node.js.
• 🖌️ Typesense – Lightning-fast, open source search engine.
• 🛡️ Supabase – Open source Firebase alternative for authentication, database, and storage.

📦 Installation

1. Clone the repository:

   git clone https://github.com/recomendapp/api.git
   cd api

2. Install dependencies:

   pnpm install

3. Set up environment variables:

   cp .env.template .env

   Add your environment variables to the .env file.

4. Run the development server:

   pnpm run dev

📚 API Documentation

Explore the API routes and their documentation using the Swagger interface:

• Swagger UI Endpoint: /api-docs
• OpenAPI JSON Schema Endpoint: /api-docs-json
• Description: Access the interactive Swagger UI to view and test all available API endpoints, including parameters and response formats. The raw OpenAPI JSON schema is also available.

Visit http://localhost:9000/api-docs after starting the service to explore the API documentation.