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.

1. Clone the Repository

   Clone the EpiNeko repository and navigate to the project directory:

   git clone https://github.com/devperez08/platform-list-anime.git
   cd platform-list-anime
   
2. Install Dependencies

   Install all required dependencies using your preferred package manager:

   npm

   npm install
   
3. Set Up Environment Variables

   Create a .env.local file in the root directory with your Supabase credentials:

   cp .env.example .env.local
   

   Then add your Supabase project details:

   .env.local

   NEXT_PUBLIC_SUPABASE_URL=your_supabase_project_url
   NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key
   

   You can get these values from your Supabase project dashboard.

4. Set Up the Database

   Run the database migrations to create the required tables:

   1. Install the Supabase CLI:

      npm install -g supabase
      

   2. Link your project:

      supabase link --project-ref your_project_ref
      

   3. Apply migrations:

      supabase db push
      

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

5. Start the Development Server

   Run the Next.js development server:

   npm run dev
   

   Open http://localhost:3000 in your browser to see EpiNeko running!

Verify Your Setup

After completing the setup, verify everything is working:

Check Database Connection

Navigate to your app and try signing up for a new account. If the signup works, your database is connected correctly.

Test Anime Discovery

On the homepage, you should see trending anime loaded from the Jikan API. If you see anime cards, the API integration is working.

Try Library Features

Sign in and try adding an anime to your library. Check your library page to confirm it was saved to the database.

What’s Next?

Now that you have EpiNeko running, explore these guides:

Authentication

Learn how to configure social auth providers

Configuration

Customize your EpiNeko instance

Library Management

Understand the library tracking system

Deployment

Deploy EpiNeko to production

Troubleshooting

Module not found errors

Make sure you’ve installed all dependencies:

rm -rf node_modules package-lock.json
npm install

Supabase connection errors

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

Jikan API rate limit errors

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

Build errors

If you encounter TypeScript or build errors:

npm run build

This will show you specific errors to fix.

Need Help?

If you run into issues:

• Check the Configuration Guide for detailed setup instructions
• Review the Environment Variables documentation
• Visit the GitHub repository for issues and discussions