Flick

Flick is a Rails development platform to generate, develop and deploy web applications and microservices. (Ruby, Ruby on Rails, Postgres, etc.)

Version 0.0.3

Prerequisites
Project Setup
Tools
Deployment

Prerequisites

Project Setup

For production, you need to replace the asterisk with the URL of your client-side application in ./config/initializers/cors.rb file.

Clone or download this repo
Run bundle install
Run rake db:create
Run bin/rails db:migrate RAILS_ENV=development
Run bin/rails db:seed RAILS_ENV=development
Run chmod +x scripts/*.bash
Run ./scripts/install-hooks.bash
Run brew install overmind (for MacOS users)
Run overmind start
Visit --> http://localhost:5000/. That's it!.

Maybe you need start postgres server

brew services start postgresql

Or, if you don't want/need a background service you can just run: pg_ctl -D /usr/local/var/postgres start

Tools

Run rubocop for Ruby lint.
Run rubocop -a for fixed some issues automatically.
Run reek . for analyzing code.
Run brakeman for static analysis and for security vulnerabilities.
Run rails_best_practices . in root app directory. Helps to find unused methods, missing indexes into database tables and many other things.

Annotate (aka AnnotateModels) usage

To annotate all your models, tests, fixtures, and factories:

cd /path/to/app
annotate

To annotate just your models, tests, and factories:

annotate --exclude fixtures

To annotate just your models:

annotate --exclude tests,fixtures,factories,serializers

To annotate routes.rb:

annotate --routes

To remove model/test/fixture/factory/serializer annotations:

annotate --delete

To remove routes.rb annotations:

annotate --routes --delete

To automatically annotate every time you run db:migrate, either run rails g annotate:install or add Annotate.load_tasks to your Rakefile. See the configuration in Rails section for more info.

Deployment

Doc for deployment is here.

PetrNikolas/flick