Atsumaru - an open source manga reader application for Android, IOS & Web

Related tags

Learning resource Atsumaru
Overview

Atsumaru is currently in alpha pre-release

We're still working on vital components for the reader, follow this repo for updates or join our Discord server.

Atsumaru | Manga Reader

Atsumaru is an open source manga reader application for Android, IOS & Web

Features

  • Advanced, fully customizable reader
  • Offline mode
  • Anilist.co integration
  • Multiple sources
  • Community driven

Contributing

Contributions of any kind are welcomed. Feel free to make pull requests with new features, improvements or modification that would benefit the application. Opening relevant issues is also welcomed and appreciated.

For support/discussion visit the Atsumaru Discord server,

Installing for development

All modern operating systems are supported GNU/Linux, Windows, Mac OS.

Prerequisites

Install the following beforehand

Steps

Run in your terminal

  1. Clone the repository 
    git clone https://github.com/TheUndo/atsumaru.git
  2. cd atsumaru
  3. Build and start the backend. Omit -d if you want to use another terminal for frontend 
    docker-compose up -d
  4. cd frontend
  5. Start frontend 
    npm i && npm run dev

After all containers are built open http://localhost:3000 to view the development app.

Technical details

Role Technology
Database MongoDB
Backend Node.js + TypeScript
Frontend UI React + TypeScript
Frontend bundler Vite
Router/Reverse proxy NGINX
Cache Redis
Search engine Meilisearch
Containerization Docker compose

Why Docker?

We use Docker to provide seamless support cross platform, for managing multiple micro services written in different languages and for offering great scaling options. Atsumaru uses over 8 different technologies, it's therefore very hard to install everything with the correct version, and make them behave together the same across Linux, Windows and Mac OS. Docker completely solves this issue.

Why TypeScript?

TypeScript is a strictly typed superset of JavaScript, it allows for static type checking at compilation time. It helps greatly in eliminating needless type errors which often occur with vanilla JavaScript. This is very useful for large projects like Atsumaru and ensures your code can be understood by others and their IDEs.

If you want to contribute but you do not know TypeScript, this is likely not an issue. Since TypeScript is incredibly powerful it will infer most types and provide helpful error messages to guide you, as mentioned before, TypeScript is a superset of JavaScript, it uses JavaScript syntax and compiles to JavaScript. If you need help, we're more than happy to provide support in our Discord server.

Comments
  • Typo in Manifest.json (manifest.webmanifest)

    Typo in Manifest.json (manifest.webmanifest)

    Describe the bug In website manifest.webmanifest and in github src/frontend/assets/oldmanifest.json, both place Manwha typo appeared (i also thought it was the right spelling until yesterday)

    The correct spelling is Manhwa (based on google)

    To Reproduce See yourself 😅

    Expected behavior Replace....

    Screenshots Screenshot_2022-07-27-00-26-43-35

    Desktop (please complete the following information):

    • OS: [e.g. iOS]
    • Browser [e.g. chrome, safari]
    • Version [e.g. 22]

    Smartphone (please complete the following information):

    • Device: [e.g. iPhone6]
    • OS: [e.g. iOS8.1]
    • Browser [e.g. stock browser, safari]
    • Version [e.g. 22]

    Additional context Add any other context about the problem here.

    opened by RaSan147 3
  • Unable to fetch library

    Unable to fetch library

    Describe the bug After trying to connect my AniList Account with Atsumaru it shows "Unable to fetch library" on the Profile Page. Tried it with different Browser and had on everyone the same Result.

    To Reproduce Steps to reproduce the behavior:

    1. Click on 'Sign In'
    2. Click on 'Sign in with AniList'
    3. Authorize the Application
    4. Go to 'https://atsu.moe/me'
    5. See the error

    Screenshots Screenshot

    Desktop:

    • OS: [Windows 10]
    • Browser [Brave, Firefox]
    • Version [v1.40.109, v102.0]
    opened by c0cee 1
  • You cant see the names on the latest updates section when you scroll down

    You cant see the names on the latest updates section when you scroll down

    Describe the bug You cant see the names on the latest updates section when you scroll down

    To Reproduce N/A

    Expected behavior See the names

    Screenshots IMG_20220616_120333

    Desktop (please complete the following information): Android/PWA

    Smartphone (please complete the following information): N/A

    Additional context From discord user Näbb Ankka (EmoFish <3)#4244 (172457522404261889)

    opened by TheUndo 1
  • Transparency should be disabled when page fill method is full width and background color is not black and gray

    Transparency should be disabled when page fill method is full width and background color is not black and gray

    Transparency should be disabled when page fill method is full width and background color is not black and gray Also most changes are because of prettier XD

    opened by PixelForg 0
  • Username clips outside if the bottom navigation bar

    Username clips outside if the bottom navigation bar

    Describe the bug If your username is too long it clips outside of the box in the navigation bar at the bottom

    Screenshots image

    Smartphone (please complete the following information):

    • Device: iPhone X
    • OS: iOS 16 beta
    • Browser safari ios
    • Version 22

    Proposed solution Instead of displaying the username, maybe change the text to "Profile" or "My profile"

    opened by PumpedSardines 0
Owner
Undo
This is not my real account
Undo
GitHub
Anime, Manga, and Light Novel Tracker Application for Windows

Courier Courier is an Anime, Manga, and Light Novel Tracker Application for Windows. With the help of AniList, this desktop app helps you manage and t

Kevin Hoang 8 Oct 5, 2022
Kakapo for Desktop, Web, iOS, Android, Babel, Reflux, ImmutableJs, HowlerJs, Webpack

Kakapo is an open source ambient sound mixer for relaxation or productivity, available on the Chrome Web Store. See also: Kakapo for Desktop & Web - K

Dredsoft 3 Sep 15, 2022
Ios-calculator-js - Calculator made with vanilla javascript and custom css based on the design of iOS devices.

ios-calculator-js This is a practice project in which I try to replicate iOS calculator's both logic and styling. In case you spot room for improvemen

Franco 1 Nov 10, 2021
Bitcoin thin client for iOS & Android. Built with React Native Google Colab

Run bluewallet-Google-Colab https://colab.research.google.com/drive/1OShIMVcFZ_khsUIBOIV1lzrqAGo1gfm_?usp=sharing Thin Bitcoin Wallet. Built with Reac

DE MINING 0 Feb 25, 2022
Grupprojekt för kurserna 'Javascript med Ramverk' och 'Agil Utveckling'

JavaScript-med-Ramverk-Laboration-3 Grupprojektet för kurserna Javascript med Ramverk och Agil Utveckling. Utvecklingsguide För information om hur utv

Svante Jonsson IT-Högskolan 3 May 18, 2022
Hemsida för personer i Sverige som kan och vill erbjuda boende till människor på flykt

Getting Started with Create React App This project was bootstrapped with Create React App. Available Scripts In the project directory, you can run: np

null 4 May 3, 2022
Kurs-repo för kursen Webbserver och Databaser

Webbserver och databaser This repository is meant for CME students to access exercises and codealongs that happen throughout the course. I hope you wi

null 14 Jan 3, 2023
Desktop app for reading and downloading manga. With clean distraction-free design and no clutter

Tonbun Tonbun is a desktop app for reading and downloading manga. With clean distraction-free design and no clutter. Build with Rust, Tauri, Vue.js, a

null 23 Nov 30, 2022
A modern ebook manager and reader with sync and backup capacities for Windows, macOS, Linux and Web

简体中文 | English Koodo Reader A cross-platform ebook reader Download | Preview | Roadmap | Document Preview Feature Format support: EPUB (.epub) Scanned

Troye Guo 8.6k Dec 29, 2022
The Circle project - The circle is an application landscape containing 3 applications There's an Angular web app called TrueYou for streaming, an expressJS backend with a Node Media server and an Android app built with Java and Kotlin for streaming.

Setup Clone the project: git clone https://github.com/Pjiwm/circle-project/ Docker Setup If you do not have Docker installed yet, but want to use the

Pim 4 Jun 21, 2022
Simple news reader that keeps the noise low.

Thud. Read news without the fuss · Report Bug · Request Feature Table of Contents About The Project Built With Getting Started Prerequisites Contribut

Samuel Bazaga 137 Jan 1, 2023
Standalone Epub reader using Bibi.

bi-epub-reader Epub reader application using Bibi. Features Beautiful epub viewer Open file as associated file type Standalone application You can see

azu 8 Aug 5, 2022
An ultra-high performance stream reader for browser and Node.js

QuickReader An ultra-high performance stream reader for browser and Node.js, easy-to-use, zero dependency. Install npm i quickreader Demo import {Quic

EtherDream 156 Nov 28, 2022
Proofie is an experimental proof-reader for VSCode that helps you write better.

Proofie Proofie is an experimental proof-reader for VSCode that helps you write better. Install You can install proofie from the VSCode Marketplace. O

Matt Mueller 7 Jul 25, 2022
Reference for How to Write an Open Source JavaScript Library - https://egghead.io/series/how-to-write-an-open-source-javascript-library

Reference for How to Write an Open Source JavaScript Library The purpose of this document is to serve as a reference for: How to Write an Open Source

Sarbbottam Bandyopadhyay 175 Dec 24, 2022
An Open-Source Platform to certify open-source projects.

OC-Frontend This includes the frontend for Open-Certs. ?? After seeing so many open-source projects being monetized ?? without giving any recognition

Open Certs 15 Oct 23, 2022
This project is for hacktoberfest to encourage new developer and open source developers to contribute to open source and improve skills which require debugging, write testable code, industry standards, problem solving and many more,

?? Blog project for hacktoberfest In this repository, you can find issues related to a blog project that is built on top of Next.js. The project is a

Shikhar 4 Oct 9, 2022
This is a project for open source enthusiast who want to contribute to open source in this hacktoberfest 2022. 💻 🎯🚀

HACKTOBERFEST-2022-GDSC-IET-LUCKNOW Beginner-Hacktoberfest Need Your first pr for hacktoberfest 2k22 ? come on in About Participate in Hacktoberfest b

null 8 Oct 29, 2022
HTML5 game framework for web and iOS

#LimeJS ##Getting started: ###Mac OS X and Linux users: Requirements: Python 2.6+, Git Clone the git repo (you have probably already done that): git c

Digital Fruit 1.4k Dec 1, 2022