Skip to content

Modern feed reader built with no-bundle Rails

License

Notifications You must be signed in to change notification settings

caiohsramos/rails-ss

Repository files navigation

Rails-ss

This is a personal project meant to be self-hosted.

This is my take on a feed reader using Rails with no-bundle JS. It relies on modern web approaches such as importmaps and the Hotwire stack. It also uses the Solid stack to manage database, queues cache, and websockets, and Tailwind + DaisyUI for styling.

Deploying

Build and run the Dockerfile. The env RAILS_MASTER_KEY is required, and it's recommended to bind /rails/db/production to a local folder for backup. You can also add a restart policy to automatically start you container.

Example:

docker run \
  -p 3000:3000 \
  -e RAILS_MASTER_KEY=123 \
  -v ./yourlocalbackup/db:/rails/db/production \
  --restart unless-stopped \
  ghcr.io/caiohsramos/rails-ss:<version>

A simple login form is present to allow usage and can be configured with the variables AUTH_USERNAME and AUTH_PASSWORD. If no variables are providade the defaults are used (admin/password).

Example:

docker run \
  -p 3000:3000 \
  -e RAILS_MASTER_KEY=123 \
  -e AUTH_USERNAME=user \
  -e AUTH_PASSWORD=pass \
  -v ./yourlocalbackup/db:/rails/db/production \
  --restart unless-stopped \
  ghcr.io/caiohsramos/rails-ss:<version>

Developing

A version manager is recommended when developing Ruby applications

  • Clone the repository
  • Run bin/setup (install gems + setup database)
  • Start the development server bin/dev

You can also use devcontainers

Screenshots

image
image
image
image

Hotkey navigation

image