ajurna/cbwebreader
1
0
Fork 0
mirror of https://github.com/ajurna/cbwebreader.git synced 2025-12-06 06:17:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update to Dockerfile to make the build much smaller.

Browse Source
This commit is contained in:
Ajurna
2021-05-05 21:27:36 +01:00
parent 1bb272e07f
commit 443e43e3f0
4 changed files with 117 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@@ -18,47 +18,8 @@ The primary frameworks and tool's are used within the application:
## Getting started
The CBWebReader is a Django project and follows the standard conventions for a Django application. To get started, clone the project into your workspace:
```bash
git clone https://github.com/ajurna/cbwebreader
```
Configure the environment using the `.env` file or setting each variable within your environment:
```bash
cp .env.example .env
```
Alternatively, set the path to your `COMIC_BOOK_VOLUME` like so:
```bash
export COMIC_BOOK_VOLUME=some_path_to_comics_directory
```
Build and run the project using docker-compose:
```bash
docker-compose up --build -d
```
## Running Tests
To run the entire test suite for CBWebReader, execute the following command:
```bash
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:
```bash
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.
The CBWebReader is a Django project and follows the standard conventions for a Django application. To get started just look in the compose folder and there is an example setup.
just rename the .env.docker file to .env and add some config details and it should work right away.
## License