agn907 / yomu

Self-hosted novel reader using third-party sources

Yomu

Novel reader for all of your different sources

Yomu is under active development, so you can expect some missing features and breaking changes in the future. If you find any issues please open an issue and I'll try to fix it as soon as possible.

Overview

Yomu is an open-source and self-hosted web and mobile(soon) novel reader where you can read novels from third-party sources.

This repository contains all the code required to build & use the self-hosted web and mobile clients,

Structure

• Next.js: the web client is built using Next.js with all code in Typescript
• React Native/Expo: the mobile client is built using React Native and Expo
• PNPM-workspace/Nx: the monorepo is managed using PNPM workspaces and Nx

Name	Path	Description
@yomu/web	apps/web	Next.js web client
@yomu/core	packages/core	Shared core library
@yomu/sources	packages/sources	Implementation of third-party sources
@yomu/ui	packages/ui	UI components for web with Shadcn
@yomu/mobile	apps/mobile	React Native/Expo mobile client (soon)

CONTRIBUTING

I'm not really looking for contributions at the moment, but if you have any suggestions please submit a pull request or open an issue and I'll try to fix it as soon as possible.

yomu's Issues

Add couple more sources

As there are only three sources at the moment, create more source implementations

Wrap novels fetch with a suspense boundary

When navigating from the explore page to one of the available sources there's a noticeable delay before the navigating because of the fetch that happening, wrap the page with a Suspense boundary or move the fetching to a component and wrap it.

Showing username as entered in home page but capitalized in username update form

The username on the main page is shown as how it's saved but capitalized in the update username form on the settings page

Updating username or password launch two success toast

When you update your username or password in the settings page, and press submit, the update happens successfully but two success toasts appear instead of only one