https://github.com/znitche/ao3-web-reader-django
django reimplementation of ao3-web-reader
https://github.com/znitche/ao3-web-reader-django
ao3 django scraper
Last synced: 8 months ago
JSON representation
django reimplementation of ao3-web-reader
- Host: GitHub
- URL: https://github.com/znitche/ao3-web-reader-django
- Owner: zNitche
- Archived: true
- Created: 2023-04-26T16:47:51.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-11T19:18:59.000Z (over 2 years ago)
- Last Synced: 2025-03-24T06:51:54.808Z (12 months ago)
- Topics: ao3, django, scraper
- Language: Python
- Homepage:
- Size: 156 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## AO3 Web Reader
Reimplementation of [ao3-web-reader](https://github.com/zNitche/ao3-web-reader).
This project won't be updated along with flask implementation.
---
### Technologies
- Django 4.2
- gunicorn
- nginx
- redis
- bootstrap
- celery
### Features
- Accounts authentication.
- Getting works from ao3.
- Grouping works using tags.
- Auto-update of added works.
- Downloading works.
### Setup
#### Dev
1. Generate `.env` config file
```
python3 generate_dotenv.py
```
2. Run dev docker services.
```
sudo docker compose -f docker-compose-dev.yml up
```
3. Run celery and celery beat workers
```
sh scripts/celery_entrypoint.sh
```
```
sh scripts/celery_beat_entrypoint.sh
```
#### Prod
1. Generate `.env` config file and change config values
- `DB_PATH` - database path
- `LOGS_PATH` - logs path
- `ALLOWED_HOSTS` - comma separated host names
```
python3 generate_dotenv.py
```
2. Run docker services.
```
sudo docker compose up -d
```
#### Accounts Management
1. Bash into web app container.
```
sudo docker container exec -it ao3_web_reader_django bash
```
2. Run accounts manager cli `python3 manage.py create_user`.
#### Tests
App contains some example tests for available apps. To run them:
```
python3 manage.py test
```