projectio

Requirements

You'll need the following installed to run the template successfully:

Ruby 2.5 or higher
bundler - gem install bundler
rails - gem install rails
Database - we recommend Postgres, but you can use MySQL, SQLite3, etc
Redis - For ActionCable & Sidekiq support
ImageMagick or libvips for ActiveStorage variants
Yarn - brew install yarn or Install Yarn
Foreman global (optional) - gem install foreman - helps run all your processes in development

Factory Bot for RSpec

Place "config.include FactoryBot::Syntax::Methods" in RSpec.config (/spec/rails_helper) & uncomment Dir join line, comment out the fixture line.

Default generators

application.rb - generators, optional values placed as below, amend/add others as needed

config.generators do |g| g.orm :active_record g.orm :active_record, primary_key_type: :uuid g.orm :active_record, foreign_key_type: :uuid g.template_engine :erb g.test_framework :rspec, fixture: false g.fixture_replacement :factory_bot, dir: 'spec/factories' g.stylesheets false g.javascripts false g.helper false g.system_tests nil end

To use UUIDs in current migration files

In current migration files, for UUIDs, ensure uncommented config generator lines, place lines in all migration files as below:
create table expression: insert after the table name: ", id: :uuid" # minus quotes, sets Primary key uuid
foreign_key expression: append: ", type: :uuid" # minus quotes, sets Foreign key uuid
In ApplicationRecord insert - self.implicit_order_column = 'created_at' under primary_abstract_class line

$ rails db:migrate:reset

All future models will have UUIDs on creation

DB seed example

User.create(
email:  Faker::Internet.email,
password: Faker::Internet.password,
first_name:  Faker::Name.first_name,
last_name:  Faker::Name.last_name,
admin: false,
announcements_last_read_at: Time.current

)

Recommended To have globally per ruby version for use in projects and templates (dont forget rehash if rbenv)

gem install foreman gem install bundler-audit gem install lefthook gem install ransack (esp if template not complete properly) gem install spreadsheet_architect (esp if template not complete properly)

Creating a new app ("Y" overwrite the Readme) after download and unzip repo.

rails new myapp -d postgresql -m template.rb

❓Having trouble? Try adding DISABLE_SPRING=1 before rails new. Spring will get confused if you create an app with the same name twice.

Running your app

bin/dev

You can also run them in separate terminals manually if you prefer.

A separate Procfile is generated for deploying to production on Heroku.

Devise extra fields

After migration field/column added,

Can be adjusted in application_controler, example below add a github_link

def configure_permitted_parameters devise_parameter_sanitizer.permit(:sign_up, keys: [:name, :avatar, :github_link]) devise_parameter_sanitizer.permit(:account_update, keys: [:name, :avatar]) end

and add to the create method in onmniauth_controller

github_link: auth.info.github_link

Active Interaction

[https://github.com/aaronlasseigne/active_interaction]

Setup We recommend putting your interactions in app/interactions. It's also very helpful to group them by model. That way you can look in app/interactions/accounts for all the ways you can interact with accounts.

app/
- controllers/
  - accounts_controller.rb
- interactions/
  - accounts/
    - create_account.rb
    - destroy_account.rb
    - find_account.rb
    - list_accounts.rb
    - update_account.rb
- models/
  - account.rb
- views/
  - account/
    - edit.html.erb
    - index.html.erb
    - new.html.erb
    - show.html.erb

Authenticate with social networks

We use the encrypted Rails Credentials for app_id and app_secrets when it comes to omniauth authentication. Edit them as so:

EDITOR=nano rails credentials:edit

Make sure your file follow this structure:

secret_key_base: [your-key]
development:
  github:
    app_id: something
    app_secret: something
    options:
      scope: "user:email"
      whatever: true
production:
  github:
    app_id: something
    app_secret: something
    options:
      scope: "user:email"
      whatever: true

With the environment, the service and the app_id/app_secret. If this is done correctly, you should see login links for the services you have added to the encrypted credentials using EDITOR=vim rails credentials:edit

Turbo/Hotwire

[https://github.com/hotwired/turbo-rails#installation]

Redis set up

On OSX

brew update
brew install redis
brew services start redis

Ubuntu

sudo apt-get install redis-server


#### Cleaning up

```bash
rails db:drop
spring stop
cd ..
rm -rf myapp

apaciuk / projectio