README.md

yomi

Issues · Getting Started

Yomi is a manga and comic-book reader solution that puts you in charge of your library. Use almost any device with a web browser to consume and sync from your own server.

Features

• Sync progress between devices.
• No central-server collecting or tracking your data.
• Library, Series, Book/Chapter management.
• Mobile/tablet support with swiping controls.

Getting Started

Note: Yomi is currently in a minimum viable product state. Features and Database schema are likely to change, please do not use in production. Report issues here.

Production

Docker Compose

version: '3'
services:
  app:
    image: ghcr.io/jakehwll/yomi
    container_name: yomi
    environment:
      - INSTANCE_URL=http://CHANGE_ME
      - INSTANCE_SECRET=CHANGE_ME
      - DATABASE_URL="file:./prod.db"
    volumes:
      - /path/to/manga:/data/library
      - /path/to/config:/data/config
    ports:
      - 3000:3000
    restart: unless-stopped

Docker

docker run \
  -e INSTANCE_URL=http://CHANGE_ME \
  -e INSTANCE_SECRET=CHANGE_ME \
  -e DOCKER_ENV=development \
  -e DATABASE_URL=file:./prod.db \
  -v /path/to/manga:/data/library \
  -v /path/to/config:/data/config \
  -p 3000:3000 \
  ghcr.io/jakehwll/yomi

Development

Preferably, these would be spun up in Docker.

1. Git clone this repo, via. git clone https://github.com/jakehwll/yomi.git
2. Copy the contents of .env.example to a new file .env. Filling accordingly.
3. yarn install to install all required dependencies.
4. yarn prisma generate to generate the development SQL.
5. yarn prisma db push to push the SQL database.
6. yarn dev to spin up yomi in Development Mode!

Contributing

TODO.