Skip to content

asip/easel-back

Repository files navigation

Easel - image viewer

alt text

This is backend of Easel.

Rails7.1 + Sorcery(authentication) + Pagy(paging) +
Shrine(upload) + ActsAsTaggableOn(tag) +
RailsAdmin (management console) + Discard(soft delete) +
Hotwire (Turbo + Stimulus3) + Bootstrap5

The frontend implemented by Ruby on Rails moved to easel-back-legacy.
(+ Vue.js 3)

This README would normally document whatever steps are necessary to get the application up and running.

Things you may want to cover:

  • Ruby version : 3.3.1

  • Rails version : 7.1.3

  • System dependencies : pnpm & postgresql & minio & redis & libvips & direnv

  • Deployment instructions

    • Run bundle install --path vendor/bundle to install the required Rubygems
    • Run pnpm install to install the required NPM packages
    • Run cp .env.local.example .env to edit environment variables
    • Run EDITOR="vi" bin/rails credentials:edit to create credentials
    • Run direnv allow to set environment variables
    • Run bundle exec rails db:create to create a development database
    • Run bundle exec rails db:migrate to create database schema
    • Run bundle exec rails db:seed to sample records
    • Run bin/rails assets:precompile to bundle the included javascript modules
    • Run bin/dev to spin up the Rails dev server
    • Hit localhost:3000 and you should be ready to go!
  • ...

License

The MIT License (MIT). Please see License File for more information.