Skip to content

Serve your manga collection over network.

License

Notifications You must be signed in to change notification settings

zackad/manga-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Manga Server

GitHub Workflow Status Codecov MIT License GitHub release (latest SemVer)

Web application to serve manga collection from your computer over the network.

Note: This is NOT a CMS (Content Management System)

Requirements

Runtime

  • PHP version 8.1 or later with following extension enabled:
    • gd
    • zip

Development

  • composer
  • NodeJS
  • yarn (replacement for npm)
  • symfony-cli (optional)

How to run

  • Download zip file from the latest release page
  • Extract
  • Open .env file and change MANGA_ROOT_DIRECTORY value to your manga collection folder. Alternatively you can copy .env file into .env.local to prevent your value to be overwritten when you update the app later.
# Please change to something like MANGA_ROOT_DIRECTORY=/data/manga
MANGA_ROOT_DIRECTORY=/
  • Open terminal
  • Navigate to extracted directory
  • Run following command
php -S 0.0.0.0:8000 public/index.php
  • Open web browser and access to http://localhost:8000
  • If your computer is connected to local network, you can access it from other device (smartphone, tablet, or other computer) that connected to the same network by accessing to it's ip address e.g http://192.168.100.12:8000

Development

  • Clone this repository
git clone https://github.com/zackad/manga-server
  • Install dependencies
cd manga-server
composer install

yarn install
  • Start the server
php -S 0.0.0.0:8000 public/index.php

# if you have symfony cli installed, you can use this command to start
# development server
symfony server:start
  • Watch the frontend compilation
# Open another terminal session and run
yarn dev

Nix Support

This project support nix flakes with direnv enabled.

# Enable direnv autoload
direnv allow

# Start development process
devenv up