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

# Quick Start

> Get EpiNeko running locally in minutes

## Get Started in 5 Minutes

Follow these steps to set up EpiNeko on your local machine and start tracking your anime collection.

<Steps>
  <Step title="Clone the Repository">
    Clone the EpiNeko repository and navigate to the project directory:

    ```bash theme={null}
    git clone https://github.com/devperez08/platform-list-anime.git
    cd platform-list-anime
    ```
  </Step>

  <Step title="Install Dependencies">
    Install all required dependencies using your preferred package manager:

    <CodeGroup>
      ```bash npm theme={null}
      npm install
      ```

      ```bash yarn theme={null}
      yarn install
      ```

      ```bash pnpm theme={null}
      pnpm install
      ```
    </CodeGroup>
  </Step>

  <Step title="Set Up Environment Variables">
    Create a `.env.local` file in the root directory with your Supabase credentials:

    ```bash theme={null}
    cp .env.example .env.local
    ```

    Then add your Supabase project details:

    ```env .env.local theme={null}
    NEXT_PUBLIC_SUPABASE_URL=your_supabase_project_url
    NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key
    ```

    <Note>
      You can get these values from your [Supabase project dashboard](https://app.supabase.com).
    </Note>
  </Step>

  <Step title="Set Up the Database">
    Run the database migrations to create the required tables:

    1. Install the Supabase CLI:
       ```bash theme={null}
       npm install -g supabase
       ```

    2. Link your project:
       ```bash theme={null}
       supabase link --project-ref your_project_ref
       ```

    3. Apply migrations:
       ```bash theme={null}
       supabase db push
       ```

    Alternatively, you can manually run the SQL from `supabase/migrations/20260218_initial_schema.sql` in your Supabase SQL editor.
  </Step>

  <Step title="Start the Development Server">
    Run the Next.js development server:

    ```bash theme={null}
    npm run dev
    ```

    Open [http://localhost:3000](http://localhost:3000) in your browser to see EpiNeko running!
  </Step>
</Steps>

## Verify Your Setup

After completing the setup, verify everything is working:

<AccordionGroup>
  <Accordion title="Check Database Connection" icon="database">
    Navigate to your app and try signing up for a new account. If the signup works, your database is connected correctly.
  </Accordion>

  <Accordion title="Test Anime Discovery" icon="search">
    On the homepage, you should see trending anime loaded from the Jikan API. If you see anime cards, the API integration is working.
  </Accordion>

  <Accordion title="Try Library Features" icon="book">
    Sign in and try adding an anime to your library. Check your library page to confirm it was saved to the database.
  </Accordion>
</AccordionGroup>

## What's Next?

Now that you have EpiNeko running, explore these guides:

<CardGroup cols={2}>
  <Card title="Authentication" icon="lock" href="/authentication">
    Learn how to configure social auth providers
  </Card>

  <Card title="Configuration" icon="gear" href="/configuration">
    Customize your EpiNeko instance
  </Card>

  <Card title="Library Management" icon="list" href="/features/library-management">
    Understand the library tracking system
  </Card>

  <Card title="Deployment" icon="cloud" href="/development/deployment">
    Deploy EpiNeko to production
  </Card>
</CardGroup>

## Troubleshooting

<AccordionGroup>
  <Accordion title="Module not found errors" icon="triangle-exclamation">
    Make sure you've installed all dependencies:

    ```bash theme={null}
    rm -rf node_modules package-lock.json
    npm install
    ```
  </Accordion>

  <Accordion title="Supabase connection errors" icon="database">
    Verify your environment variables are set correctly:

    * Check that `.env.local` exists in the root directory
    * Ensure your Supabase URL and anon key are correct
    * Restart the dev server after changing environment variables
  </Accordion>

  <Accordion title="Jikan API rate limit errors" icon="circle-exclamation">
    The Jikan API has rate limits. If you see 429 errors:

    * Wait a few seconds between requests
    * The app includes automatic caching to reduce API calls
    * Consider implementing a longer cache duration in `src/services/jikan.ts`
  </Accordion>

  <Accordion title="Build errors" icon="code">
    If you encounter TypeScript or build errors:

    ```bash theme={null}
    npm run build
    ```

    This will show you specific errors to fix.
  </Accordion>
</AccordionGroup>

## Need Help?

If you run into issues:

* Check the [Configuration Guide](/configuration) for detailed setup instructions
* Review the [Environment Variables](/development/environment-variables) documentation
* Visit the [GitHub repository](https://github.com/devperez08/platform-list-anime) for issues and discussions