Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/meteatamel/amathus
An RSS reader, transformer, and a web API
https://github.com/meteatamel/amathus
Last synced: 2 days ago
JSON representation
An RSS reader, transformer, and a web API
- Host: GitHub
- URL: https://github.com/meteatamel/amathus
- Owner: meteatamel
- License: apache-2.0
- Created: 2020-01-22T13:34:29.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T09:34:13.000Z (about 2 years ago)
- Last Synced: 2024-12-19T16:58:51.752Z (15 days ago)
- Language: C#
- Homepage:
- Size: 1.73 MB
- Stars: 7
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Amathus
Amathus reads RSS feeds, transforms them into a common feed format, and exposes them behind a Web API. Written in ASP.NET Core and deployed as 3 separate Cloud Run microservices on Google Cloud.
## Architecture
## Setup
Make sure `gcloud` points to the right project and you're in [Amathus](Amathus) folder where [Amathus.sln](Amathus/Amathus.sln) is.
(One time) Enable Google Cloud services needed:
```bash
scripts/enable
```
### Amathus.Reader
Build:
```bash
scripts/build reader
```
Deploy a private service:
```bash
scripts/deploy reader
```
(One time) Create a Cloud Storage bucket and a Scheduler job to invoke the service:
```bash
scripts/setup_reader
```
### Amathus.Converter
Build:
```bash
scripts/build converter
```
Deploy a private service:
```bash
scripts/deploy converter
```
(One time) Set converter to receive Pub/Sub messages with bucket changes:
```bash
scripts/setup_converter
```
### Amathus.Web
Build:
```bash
scripts/build web
```
Deploy a public service:
```bash
scripts/deploy web public
```
### AmathusClient
There's a Flutter client. See [README.md](AmathusClient/README.md)
for details.
## Debugging
## Run locally
Inside [Amathus.Reader](Amathus/Amathus.Reader), [Amathus.Converter](Amathus/Amathus.Converter), or [Amathus.Web](Amathus/Amathus.Web) folder:
```bash
dotnet run
```
## Build and run Docker image locally
Inside [Amathus](Amathus) folder, you can build and run the image for each service. For example, for `Amathus.Web`:
Build image:
```bash
docker build -t amathus-web -f Amathus.Web/Dockerfile .
```
Run image:
```bash
docker run -p 8080:8080 amathus-web
```