AniTrack

Features

• List Popular Anime: Provides users with ranked list of top 100 anime based on reviews.
  • Implementation can be found in ./web-app/server/queries/anime.ts
• Review Anime: Add a rating and comment for a specified anime
  • Implementation can be found in ./web-app/server/queries/reviews.ts
• Adding New Anime: Contribute to the community by adding new anime titles.
  • Implementation can be found in ./web-app/server/queries/add_anime.ts
• Find Friends based on Shared Anime: Helps users discover potential friends based on shared anime interests
• View Watch History: User can view all anime they watched, are watching, or want to watch.

Prerequisites

Before setting up the application, ensure you have the following installed:

• Node.js
• Next.js
• PostgreSQL

File Structure

• /web-app: the React app that users will interact with.
• /data: includes the anime data that powers the app.
  • /data/production-data: include the production dataset
  • /data/sample-data: include the sample dataset
• /sql: includes the sql scripts used to create and test the database

Environment Setup

1. Clone the Repository:

   git clone https://github.com/patel-aaryan/cs348.git

Connect to the Database (for db testing, not required for running the app)

• Authenticate to the database hosted on Neon with the following:

  psql "postgresql://neondb_owner:npg_57rRMbpQwjOA@ep-bitter-cherry-a84kfw3m-pooler.eastus2.azure.neon.tech/neondb?sslmode=require"

  Run any sql command to interact with the database.

• Note: Tables with sample data are already created in the database. Since it's hosted on Neon, you don't need to create the tables yourself. But if you want to test creating tables, you can drop all tables, and the run /sql/create_tables.sql to create the tables. To populate the tables, run

  \copy table_name FROM 'path/to/sample-data/data.csv' DELIMITER ',' CSV HEADER`

  to populate a specific table with sample data

• To execute the any sql file from local machine and check the output, run the following command:

  psql "postgresql://neondb_owner:npg_57rRMbpQwjOA@ep-bitter-cherry-a84kfw3m-pooler.eastus2.azure.neon.tech/neondb?sslmode=require" -f <path/to/file.sql> -o <path/to/file.out>

Production dataset

• Note: Production dataset already been generated. But if you want to generate it again, run the clean_data.py script (note: pandas must be installed).

• The tables have already been created in Neon so to load the production dataset into the database, run

  \copy table_name FROM 'path/to/production-data/data.csv' DELIMITER ',' CSV HEADER`

  to populate a specific table with production data

Running the Application

1. Change the directory to the web-app folder:

   cd web-app

2. Install Dependencies: Make sure you have installed Node.js and npm on your machine. Node version must be greater tha 18.18.0.

   npm install

3. Run the server locally:

   npm run dev

4. Access the Application:

   Open your browser and navigate to http://localhost:3000.