Skip to content

Latest commit

 

History

History
123 lines (79 loc) · 4.57 KB

README.md

File metadata and controls

123 lines (79 loc) · 4.57 KB
Raw
Bookracy logo

Bookracy Library

A Shadow Library for the Digital Age

Explore a vast collection of books, articles, and documents – easily accessible on any device.

Discord server GitHub downloads

CI License: Apache-2.0 Translation status

Access Library

Bookracy Stable Bookracy Beta

Compatible with all modern browsers.

Features

  • Browse and download a wide range of books, scientific documents, manga and more.
  • Customizable reading experience with built in epub reader, adjustable fonts, themes, and more.
  • Sync across devices to access your library from anywhere.
  • Tag, organize and share your collections
  • Regular updates to the catalog with new additions every hour.
  • Download your epubs, pdfs and mobi to use how you want offline.
  • Advanced search filters for easy discovery.
  • Plus much more...

Getting Started

Prerequisites

Ensure you have the following installed on your local machine:

  • Node.js (v16 or higher recommended)
  • PNPM (v7 or higher recommended)

Installation

  1. Clone the repository:

    git clone https://github.com/bookracy/frontend.git
cd frontend

  2. Install dependencies using PNPM:

    pnpm install

Running the Application

Start the development server:

pnpm run dev

The application will be available at http://localhost:5173.

Building for Production

To build the project for production:

pnpm run build

This will create an optimized build in the dist directory.

Contributing

We welcome contributions! Please read the Code of Conduct and Contributing Guide before making any contributions.

Repositories

bookracy/frontend - GitHub bookracy/frontend-lite - GitHub

Credits

Thank you to everyone who has contributed to Bookracy!

Bookracy contributors

Disclaimer

The developer(s) of this project have no affiliation with the content providers, and this library hosts no copyrighted material.

License

Copyright © 2024 The Bookracy Open Source Project

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.