Files
Evection/README.md
T
ksmithandClaude Sonnet 5 c635cd9330 Scaffold Django project and add first-run auth flow
Sets up the Evection project structure: split settings supporting both
SQLite and PostgreSQL via DATABASE_URL, Celery+Redis wiring, and the
planned app layout (accounts, feeds, articles, rules, search, reader,
pwa, core). Implements multi-user auth with a FreshRSS-style first-run
setup wizard, login/logout, and admin-only user management, covered by
automated tests.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-10-30 15:56:58 -06:00

30 lines
653 B
Markdown

# Evection
A self-hosted RSS/Atom feed reader, in the spirit of FreshRSS, built in Python
(Django) instead of PHP. Installable as a PWA on mobile.
Status: early scaffolding — auth and accounts are in place; feed fetching,
reading UI, search, rules, OPML, and the PWA layer are still to come.
## Development setup
```bash
python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
cp .env.example .env
python manage.py migrate
python manage.py runserver
```
Visit `http://localhost:8000/` — you'll land on the first-run setup wizard to
create the instance's admin account.
## Tests
```bash
pytest
ruff check .
black --check .
```