Generalized manga reading framework. Adapted for Kaguya-sama manga, but can be used generically for any and all manga.
Testing Supported By
⚠ Note: This install instruction below focuses on Debian OS Bullseye (e.g. RaspberryPi arm64) only.
- Clone Guyamoe's repository.
git clone https://github.com/Alexgamer470/guyamoe /your/installation/path
-
Change the installation path and HOST_IP to the IP you are going to host on in
./docker/docker-compose.yml -
Run the docker files
cd ./docker && docker compose build && docker compose up
- Clone Guyamoe's repository.
git clone https://github.com/Alexgamer470/guyamoe /your/installation/path
-
Create a custom template with build method
Repository, paste the URL of this repository intoRepository URLand set theCompose pathtodocker/docker-compose.yml. Click onCreate custom template. -
Now click on the template and then on
View stack(directly under the template's name). -
Edit the installation path to the path where you have cloned this repository and
HOST_IPto the IP you are going to host on. Click onDeploy the stack.
gitpython 3.6.5+ (incl. dependencies)python psycopg2 dependencies (libpq-dev)pipvirtualenv
sudo apt install git python3 build-essential python3-dev libpq-dev python3-pip virtualenv
- Create a venv for Guyamoe in your home directory.
virtualenv ~/guyamoe
- Clone Guyamoe's source code into the venv.
git clone https://github.com/Alexgamer470/guyamoe ~/guyamoe/app
- Activate the venv.
cd ~/guyamoe/app && source ../bin/activate
- Install Guyamoe's dependencies.
pip3 install -r requirements.txt
At this point you may get an error that pg_config is missing. In that case, you're missing the libpq-dev package. Install development version of PostgreSQL.
- Change the value of the
SECRET_KEYvariable to a randomly generated string.
sed -i "s|\"o kawaii koto\"|\"$(openssl rand -base64 32)\"|" guyamoe/settings/base.py
- Generate the default assets for Guyamoe.
python3 init.py
- Create an admin user for Guyamoe.
python3 manage.py createsuperuser
- Collect static files. Otherwise the admin static files won't be accessible.
python3 manage.py collectstatic
Note: Zero pad chapter folder numbers like so: 001 for the Kaguya series (this is how the fixtures data for the series has it). It doesn't matter for pages though nor does it have to be .jpg. Only thing required for pages is that the ordering can be known from a simple numerical/alphabetical sort on the directory.
This will host the website on localhost:8000
python3 manage.py runserver- Keep this console active, otherwise the server will be closed.
For some peopple the command above won't make the site accessible. In that case run:
python manage.py runserver 0.0.0.0- remember to replacelocalhostwith your hosts internal IP in./guyamoe/settings/local.py, in order to add it toALLOWED_HOSTS.
/- home page/about- about page/admin- admin view (login with created user above)/admin_home- admin endpoint for clearing the site's cache/reader/series/<series_slug_name>- series info and all chapter links/reader/series/<series_slug_name>/<chapter_number>/<page_number>- url scheme for reader opened on specfied page of chapter of series./api/series/<series_slug_name>- all series data requested by reader frontend/media/manga/<series_slug_name>/<chapter_number>/<page_file_name>- url scheme to used by reader to actual page as an image.
Before starting the server, create a media folder in the base directory. Add manga with the corresponding chapters and page images. Structure it like so:
media
└───manga
└───<series-slug-name>
└───001
├───001.jpg
├───002.jpg
└───...
E.g. Kaguya-Wants-To-Be-Confessed-To for <series-slug-name>.