CBWebReader is web-based CBR and CBZ file reader implemented in Django. The application allows a user to host their collection of digital comics (CBR & CBZ formats) as a remotely accessible collect.
The following technologies will aid development by ensuring a consistent development environment for all developers:
The following frameworks and tool's are used within the application:
- Django 2.0
- python 3.5+
- rarfile python library by Marko Kreen (included)
- Unrar by winrar
- django-recaptcha by praekelt
The CBWebReader is a Django project and follows the standard conventions for a Django application. To get started, clone the project into your workspace:
git clone https://github.com/ajurna/cbwebreader
Configure the environment using the
.env file or setting each variable within your environment:
cp .env.example .env
Alternatively, set the path to your
COMIC_BOOK_VOLUME like so:
Build and run the project using docker-compose:
docker-compose build docker-compose up
To run the entire test suite for CBWebReader, execute the following command:
docker-compose run app pytest -vvv
Syncing comic books
Once the application has been configured and runs for the first time, an initial import of comics will be made available to browse and view. However, future additions will need to be synced before they will be available. A sync can be performed by running the following command:
docker-compose run app python manage.py scan_comics
It is recommended that you configure a scheduled task to run the sync as frequently as you wish to ensure your collection is up-to-date.
This is a human-readable summary of (and not a substitute for) the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) License.