MyAnimeListDashboard

A dashboard for anime recommendations!
Report Bug Request Feature

(back to top)

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Setup
   • Usage
3. Demo
4. Contributing
5. Contact

About The Project

This project aims to create an interactive dashboard for the anime recommendation dataset available on Kaggle. The dashboard will allow users to explore anime data, view recommendations, and gain insights into the dataset. The data, consisting of anime and rating information, is stored in a Supabase database. Python is used to query this data efficiently with DuckDB, and Streamlit is utilized to build the interactive web-based dashboard.

Built With

• Core Language
  • 
• Database/Data Layer
  • 
  • 
• Data Analysis/Visualization
  • 
  • 
  • 
  • 
• Deployment/Framework
  • 
• Environment/Tools
  • 
  • 
  • 

(back to top)

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Python 3.8+
• Access to a Supabase instance with the anime and rating datasets.

Setup

1. Clone the repository:

   • Using Git:

     git clone https://github.com/drod75/MyAnimeListDashboard.git
     cd MyAnimeListDashboard

   • Using GitHub CLI (gh):

     gh repo clone drod75/MyAnimeListDashboard
     cd MyAnimeListDashboard

2. Choose your environment setup:

   • Option 1: Using uv (recommended)

     # Install uv if you haven't already
     pip install uv
     # Create a virtual environment and install dependencies
     uv venv
     uv pip install -r requirements.txt

   • Option 2: Using venv and pip

     # Create a virtual environment
     python -m venv .venv
     # Activate the environment
     # On Windows
     .venv\Scripts\activate
     # On macOS/Linux
     source .venv/bin/activate
     # Install dependencies
     pip install -r requirements.txt

3. Configure your environment:

   Create a .env file in the root directory with your Supabase database credentials. You can find these in your Supabase project's database settings.

   DB_NAME="postgres"
   DB_USER="postgres"
   DB_PASSWORD="YOUR_DATABASE_PASSWORD"
   DB_HOST="YOUR_DATABASE_HOST"
   DB_PORT="5432"
   
   SUPABASE_URL="YOUR_SUPABASE_URL"
   SUPABASE_KEY="YOUR_SUPABASE_KEY"

Usage

To run the Streamlit dashboard:

streamlit run main.py

(back to top)

Demo

Coming Soon!

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

David Rodriguez - dr507498@gmail.com - LinkedIn

Project Link: https://github.com/drod75/MyAnimeListDashboard

(back to top)