> ## Documentation Index
> Fetch the complete documentation index at: https://logspot-a587aedc.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Start viewing production logs in minutes — even from your phone.

## Get started in three steps

Add Logspot to your project and start debugging issues without dashboards or cloud consoles.

### Step 1: Install Logspot

> **Install Logspot in your project.**
>
> 1. Python (pip): ` pip install logspot`
>
> 2.  Node.js (npm):`npm i logspot-ui`
>
> > [!TIP]
> >
> > Your preview updates automatically as you edit/deploy files.

### Step 2: Deploy your changes

> **Enable the /logs endpoint**
>
> Logspot exposes a `/logs `endpoint directly inside your application.
>
> From this endpoint you can:
>
> * View logs in real time
> * Search and filter logs
> * Limit log output
> * Download logs when needed
>
> This endpoint works in both development and production environments.

> **Backend Implementation**
>
> ```python theme={null}
> from logspot import setup_logs
>
> app = Flask(__name__)
>
> # Initialize LogSpot
> # This registers the /logs blueprint and attaches logging methods to 'app'
> logger = setup_logs(app, service="PROJECT_NAME",telegram_chat_id=OWNER_CHAT_ID, telegram_bot_token=BOT_ID)
> ```

> **UI Implementation**
>
> ```javascript theme={null}
> import React from "react";
> import { LogViewer } from "logspot-ui";
>
> export default function LogsPage() {
>     return (
>         <div>
>             <LogViewer backendUrl="http://127.0.0.1:5000/logs" limit={20} />
>         </div>
>     );
> }
> ```

> **Secure the endpoint (recommended)**
>
> Logs can contain sensitive information.\
> Protect the `/logs` endpoint using one of the following:
>
> * Basic authentication
> * Token-based authentication
> * IP allowlisting
> * Your existing authentication middleware
>
> Logspot is self-hosted, so security is completely under your control.
>
> > [!NOTE]
> >
> > **Logspot will provide authentication soon !!!**

### Step 3: Go live

> **View logs instantly**
>
> 1. Once your app is deployed, open:
>
>    ```bash theme={null}
>    https://your-app.com/logs
>
>    ```
>
>    You can now:
>
>    * Debug production issues from your phone
>    * Quickly identify errors and crashes
>    * Filter only critical or error logs
>    * Download logs for offline debugging
>
>    No dashboards. No cloud consoles. Just your app.

> [!NOTE]
>
> **Need help?** Take help from GPT  : )


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.