AnimeThemes is a simple and consistent repository of anime opening and ending themes. We provide direct links to high quality WebMs of your favorite OPs and EDs for your listening and discussion needs.

This is the repository for the server application that is responsible for AnimeThemes.moe resource management, API, and other services related to serving the AnimeThemes database.

This project is powered by Laravel, a PHP framework for web artisans.

Installation

• Prerequisites
• Setup
  • Running
• Extra Configuration
  • Feature Flags
  • Users
  • Search
  • Local Storage
• Contributing
• Resources

Prerequisites

• Docker

Docker will setup PHP, MySQL and Typesense for you. If you are on Windows, use the WSL terminal.

Setup

# Clone the repository
git clone git@github.com:AnimeThemes/animethemes-server.git
cd animethemes-server

cp .env.example-sail .env

# Install Composer dependencies using a throwaway container
docker run --rm \
    -u "$(id -u):$(id -g)" \
    -v "$(pwd):/var/www/html" \
    -w /var/www/html \
    laravelsail/php82-composer:latest \
    composer install --ignore-platform-reqs

# Start sail
./vendor/bin/sail up -d

# Generate an application key
./vendor/bin/sail artisan key:generate

# Migrate the database, create fake data and run seeders
./vendor/bin/sail artisan db:sync --drop

You can optionally configure a shell alias following the official Sail guide. The following instruction assume you have configured a shell alias. If not you need to replace sail with ./vendor/bin/sail.

Open the following file and paste the contents there:

For Windows/WSL: C:\Windows\System32\drivers\etc\hosts

For Linux: /etc/hosts

127.0.0.1 admin.animethemes.test
127.0.0.1 animethemes.test
127.0.0.1 api.animethemes.test
127.0.0.1 graphql.animethemes.test

Restart the container:

sail restart
sail artisan optimize

Running

If all went well, AnimeThemes should be live at http://animethemes.test.

Extra Configuration

Feature Flags

Features that require external services are disabled by default. Here we will review the configuration options for enabling additional features.

For example, if we want to enable video streams, we need to set the App\Features\AllowVideoStreams value on DB to true. We recommend setting up a local archive for the videos_local disk.

Users

# Open the terminal of tinker
sail artisan tinker

# Create the user
$user = User::factory()->create(['name' => 'User Name', 'email' => 'example@example.com', 'password' => 'password', 'email_verified_at' => now()]);

# It is useful to create a user with the Admin role with permissions to all actions
# Assign the Admin role to the user
$user->assignRole('Admin');

Search

Import models into our indices using:

sail artisan scout:import-all

Local Storage

We are not required to set up s3 buckets in order to interact with media. We have the option to configure local filesystems that we can stream audio/video from and download scripts from.

Configure local filesystem disks in .env

AUDIO_DISK_DEFAULT=audios_local
AUDIO_DISKS=audios_local
...
DUMP_DISK=dumps_local
...
IMAGE_DISK=images_local
...
VIDEO_DISK_DEFAULT=videos_local
VIDEO_DISKS=videos_local
...
SCRIPT_DISK=scripts_local

By default, app storage directories will be used to store media. External directories can be specified as the root if media is stored elsewhere.

Remark: It is recommended to include a .gitignore at the root directory of the filesystem so that media files are not indexed by git.

AUDIO_DISK_ROOT="E:\\animethemes-audios\\"
...
DUMP_DISK_ROOT="E:\\animethemes-db-dumps\\"
...
IMAGE_DISK_ROOT="E:\\animethemes-images\\"
...
SCRIPT_DISK_ROOT="E:\\animethemes-scripts\\"
...
VIDEO_DISK_ROOT="E:\\animethemes-videos\\"

Create symbolic links to target storage directories.

sail artisan storage:link

Contributing

Please review the Contributing Guide in the wiki for detailed instructions.

Resources

Please make use of the #api channel in the Discord Server for questions pertaining to the AnimeThemes database or API.