Skip to content

Latest commit

 

History

History
160 lines (105 loc) · 4.9 KB

README.md

File metadata and controls

160 lines (105 loc) · 4.9 KB
Raw

animeviz

This is the repository for the website animeviz.

Setting up the development environment

  1. Install python, poetry, mysql (make sure mysql is on PATH) and (optionally) stella on your system.

  2. Clone the repository (fork first if you want to contribute).

git clone https://github.com/shravanasati/animeviz.git

Change the github username in the above URL if you have forked the repository.

  1. Create a virtual environment (strongly recommended).
python -m venv venv

And activate it.

On Windows powershell

./venv/Scripts/Activate.ps1

On unix based systems

source ./venv/bin/activate
  1. Install all the dependencies.
poetry install --no-root
  1. Setup the database.

Login into MySQL using the command:

mysql -u {username} -p

Create the animeviz database:

create database animeviz;

Now, go the project base and add a file named with credentials.env with the following content:

MYSQL_USERNAME={username}
MYSQL_PASSWORD={password}
MYSQL_HOST=localhost
MYSQL_PORT=3306
DB_POOL_SIZE=50
DB_POOL_RECYCLE=1800

The host and port arguments here are the default ones. If your MySQL server runs on a different host and port, modify them accordingly. The DB_POOL_SIZE indicates the size of connection pool used my SQLAlchemy. The DB_POOL_RECYCLE value indicates the duration in seconds after which the connection should be recycled

(don't include curly braces in the file)

  1. MAL setup.

It is quite lengthy, read the mal_setup.md file for more information.

After you obtain the client ID and client secret from MyAnimeList, append the following lines in credentials.env:

MAL_CLIENT_ID={client_id}
MAL_CLIENT_SECRET={client_secret}

(again DO NOT include curly braces)

  1. Cloudflare Turnstile setup.

The website uses the Cloudflare Turnstile captcha service to protect the visualization endpoint from bots.

Generate a site key and a secret key from the turnstile dashboard and put them in the credentials.env file.

TURNSTILE_SITE_KEY={sitekey}
TURNSTILE_SECRET_KEY={secretkey}

Along with that you'd also need to change the form.js file and change the site key in the window.onloadTurnstileCallback function.

  1. More configurations.

Another configuration you'd need to be able to run the server is SECRET_KEY, which is used by login manager to keep client-side sessions secure.

Generate a safe secret key using python:

python -c "import secrets;print(secrets.token_hex(64))"

Set the value as follows, in the credentials.env file:

SECRET_KEY={secret_key}

The application employs the flask-limiter library to rate limit all incoming requests. During development phase, memory backend is suggested to be used.

Add this line to the credentials.env file too.

FLASK_LIMITER_STORAGE_URI=memory://

These are more configurations:

PROD=0
MAX_ANIME_SEARCH_THREADS=25

The PROD variable indicates if the website is running on a production server, behind a reverse proxy like nginx. Set it to 1 only when this python app is being reverse proxied.

MAX_ANIME_SEARCH_THREADS is the number of threads the application will spawn when searching genres of anime from the data.

  1. Run the server.
flask --app app run

If you've installed stella, you can get live reloading capabilities for both backend and frontend.

stella run server

for just running the server.

stella run

for running the server as well as having reload on browser.

Deployment Guide

This guide demonstrates how to self host animeviz on a VPS with Ubuntu 22.04.

  1. Do the above (setting up the development environment) steps.

  2. Follow this tutorial to install and setup gunicorn, nginx, and certbot.

  3. Install and configure MySQL using this tutorial.

  4. Install and configure redis using this tutorial.

  5. Edit the FLASK_LIMITER_STORAGE_URI parameter in credentials.env to something like this redis://:foobared@localhost:6379 where foobared is the redis authentication password, and localhost and 6379 are the host and port redis is listening on, respectively. Refer the flask limiter docs for more details.

  6. Go to the MAL API page and edit the App Redirect URL to replace localhost with the domain you've configured, and the homepage URL too.