RanobeDB

RanobeDB is a light novel database website.

Visit us at https://ranobedb.org

Features

• Add/edit books, series, releases, staff, and publishers to the database
• Keep track of books you have read, want to read, finished, etc.

Contributing

Prerequisites

RanobeDB is written in SvelteKit and TypeScript and the database uses PostgreSQL. You will need to install Node.js, PostgreSQL and pnpm.

Installation

1. Clone the repo or fork it on Github and then clone your own repo

git clone https://github.com/Blastose/ranobedb.git

or

git clone https://github.com/{YOUR_ACCOUNT_HERE}/ranobedb.git

2. Install npm packages with pnpm

pnpm install

3. Copy the .env.example file to .env and fill it out. If you are only running the site locally, you can skip filling out the MAILGUN_DOMAIN and MAILGUN_API_KEY fields

4. Create a PostgreSQL database with the same name as the one you put in the DATABASE_URL env variable, then run the database migration script

npx kysely migrate:latest

5. Seed the database (optional)

   • Add test users from sql/test_users.sql or
   • Populate the database with the test database dump db-seed.dump
   • Run the database migration script again

6. Start the development server

pnpm run dev

Pull requests

For small fixes, like typos, you can create a branch and submit a pull request with your changes.

For larger fixes or feature requests, please discuss it on our Discord server first.

Acknowledgements

Thanks to:

• VNDB for inspiring and influencing this project
• LNRelease for compiling a list of English light novels
• Ranobe Mori for compiling a list of Japanese light novels

License

AGPL-3.0