Self-hosted RSS news aggregator for your browser home page
[![CodeQL](https://github.com/tomofumikitano/frontpage/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/tomofumikitano/frontpage/actions/workflows/codeql-analysis.yml)
# Features
- PC/Mobile view
- Dark Theme
- Sortable Feeds
# Screenshots
PC |
:-------------:|
![PC View](docs/img/PC.png) |
Mobile Dark | Mobile Light
:-------------------------:|:-------------------------:
|
# Demo
https://frontpageshowcase.herokuapp.com/feeds/
No email required. May take 20-30 secs before Heroku wakes sleeping container up.
# Setup
## Requirements
- PostgreSQL Server
- Create database and user for this application. See `scripts/db/setup_postgres.sql` for detail.
## Docker Compose
1. Create `.env` file with following format.
```sh
SECRET_KEY=
DATABASE_URL=postgres://frontpage:frontpage@192.168.0.100:5432/frontpage
```
- `SECRET_KEY`: run `scripts/generate_secret_key.sh`
- `DATABASE_URL`: `postgres://:@:/`
2. Run `docker-compose`
```sh
docker-compose up -d
```