Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sistracia/rss-bookmarkr
Bookmark your favorite RSS feeds
https://github.com/sistracia/rss-bookmarkr
client-server elmish-applications fable feliz fsharp postgresql react rpc saturn type-safe
Last synced: about 1 month ago
JSON representation
Bookmark your favorite RSS feeds
- Host: GitHub
- URL: https://github.com/sistracia/rss-bookmarkr
- Owner: sistracia
- License: mit
- Created: 2024-02-12T03:03:04.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-18T12:11:26.000Z (about 2 months ago)
- Last Synced: 2024-09-30T06:22:26.138Z (about 2 months ago)
- Topics: client-server, elmish-applications, fable, feliz, fsharp, postgresql, react, rpc, saturn, type-safe
- Language: F#
- Homepage: http://rssbookmarkr.sistracia.com
- Size: 247 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RSS Bokmarkr
Bookmark your favorite RSS feeds.
## Development
### Prerequisite Tools
- [Bun](https://github.com/oven-sh/bun) 1.0
- [.NET](https://dotnet.microsoft.com/en-us/download) 8.0
#### Why need Bun?
Because the Client app use [Feliz](https://github.com/Zaid-Ajaj/Feliz) and it's resulting code that depends to React in the end, also the Client app use [Daisy UI](https://daisyui.com/) ( [Feliz.DaisyUI](https://dzoukr.github.io/Feliz.DaisyUI/#/) ) and it's depends to [Tailwind](https://tailwindcss.com/), and some other tooling that need to be installed from NPM like [Elmish.Debbuger](https://github.com/elmish/debugger) depends to [remotedev](https://github.com/zalmoxisus/remotedev). The reason to choose [Bun](https://github.com/oven-sh/bun) instead of `npm` or other package manage ([Node.js](https://nodejs.org/en)) is because [Bun](https://github.com/oven-sh/bun) is such a cool project.
#### Why need .NET?
It's tool that needed to run and compile F#.
### Install dependencies
```bash
# Install dependencies for Client app
bun install
# Install dependencies for Server app
dotnet tool restore
dotnet restore
dotnet paket restore
```
Use [Paket](https://fsprojects.github.io/Paket/) for dependency manager for the Server app.
Just because most (maybe all) F# app found out there use it, but it's such a cool project.
### Start Development
Create `.env` file, [see example](./web/.env.example).
```bash
cp .env.example .env # change the value inside later
```
See the script in [package.json here](./web/package.json) and in [Makefile here](./web/Makefile)
```bash
bun run start
```
## Migration
```bash
cd web
```
Create `migrondi.json`, see [Migrondi](https://github.com/AngelMunoz/migrondi).
```bash
cp migrondi.example.json migrondi.json
```
Edit the `connection` in `migrondi.json`, fill the _blank_ value. After that run the migration.
```bash
make migrate_up
```
## Deployment
### Using Docker
See the [Dockerfile here](./web/Dockerfile).
```bash
cd web
```
Create `.env` file, [see example](./web/.env.example).
```env
ConnectionStrings__RssDb=
MailSettings__Server=
MailSettings__Port=
MailSettings__SenderName=
MailSettings__SenderEmail=
MailSettings__UserName=
MailSettings__Password=
PUBLIC_HOST=
PORT=
HOSTNAME=
ASPNETCORE_URLS=http://${HOSTNAME}:${PORT}
```
#### Using `docker compose up`
See the [docker-compose.yaml here](./web/docker-compose.yaml).
```bash
docker compose up -f docker-compose.yaml
```
#### Using `docker build` and `docker run`
```bash
# Build
docker build -t rss-bookmarkr -f ./Dockerfile .
# Run
docker run --env-file ./.env rss-bookmarkr
## or
docker run \
-e ConnectionStrings__RssDb="POSTGRES CONNECTION STRING" \
-e MailSettings__Server= \
-e MailSettings__Port= \
-e MailSettings__SenderName= \
-e MailSettings__SenderEmail= \
-e MailSettings__UserName= \
-e MailSettings__Password= \
-e PUBLIC_HOST= \
-e ASPNETCORE_URLS="" \
rss-bookmarkr
```
## Unit Testing
Run unit test for `Server` project.
```bash
make test_unit_server
```
## E2E Testing
Prepare the app in isolated Docker environment.
```bash
make test_e2e_setup
```
Wait until the app's container healthy, then run the migration.
```bash
make test_e2e_migration
```
Run E2E testing.
```bash
bun run test
```
Cleanup the app's container.
```bash
make test_e2e_teardown
```