Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/karmek-k/tinyreader
📰 An RSS reader written in Symfony
https://github.com/karmek-k/tinyreader
docker php rss rss-reader symfony
Last synced: about 2 months ago
JSON representation
📰 An RSS reader written in Symfony
- Host: GitHub
- URL: https://github.com/karmek-k/tinyreader
- Owner: karmek-k
- License: mit
- Created: 2021-06-10T16:01:54.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-11-21T11:06:07.000Z (about 1 year ago)
- Last Synced: 2023-11-21T12:26:45.494Z (about 1 year ago)
- Topics: docker, php, rss, rss-reader, symfony
- Language: PHP
- Homepage:
- Size: 467 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TinyReader
## Installation
### Local environment for development
You'll need:
- PHP 8.1 or newer
- Docker and Docker Compose (Docker Desktop is fine too, it installs both)Create a `db.env` file from template and edit it:
```
cp db.example.env db.env
```Launch Docker Compose in the background:
```
docker compose up -d
```You are not able to use the database right now, as it has not been migrated.
Migrate the database **while `docker compose` is running in the background**:```
php bin/console doctrine:migrations:migrate -n
```Create a user:
```bash
# normal user
php bin/console tr:user:create# admin user
php bin/console tr:user:create -a
```Start the development server:
```
php bin/console serve
```It may ask you to add some self-signed certificates.
It's necessary in order to use HTTPS locally.Now you should be able to see the login page at `http://localhost:8000`
#### Worker process
Execute the following script:
```
php bin/console messenger:consume async --memory-limit=128M
```This script has to be running all the time when the server is active,
otherwise asynchronous feed reloading will not work.
The script terminates when its memory usage exceeds 128M of memory,
so it is highly recommended to use a process manager
like [PM2](https://pm2.keymetrics.io/) or [Supervisor](http://supervisord.org/) to keep the worker alive.