Giter VIP home page Giter VIP logo

rails-template's Introduction

Rails Template for new applications

This should get the developer all the way to the best logical point of generating "Business Logic".

(MVP) Target start to finish time is 30 minutes.

This is an opinionated rails template designed to get from zero to sane quick-start application with Production-worth characteristics. This means that it should not require a lot of manual steps.

If this template requires major updates everytime there are minor changes in the ecosystem, thats a bad sign. Straight file copies from stock templates are to be avoided. They're a pain to maintain.

Please read the entire template to understand all the steps.

Some high level concepts this is going to account for:

  • Launchable to a publically-available deployed environment like Heroku. Terraform might be the awesome solution here but might fall out of scope.
  • Should maintain a cost-free setup to get off the ground
  • Relying on services that might cost eventually is not necessarily bad
  • Assumes a User. Not sure if this is easy to do as an optional argument. Authentication is common, this might be the strongest opinion. https://guides.rubyonrails.org/rails_application_templates.html#ask-question
  • This assumes making a "professional-level" app as a requirement so the setup for easy "Professional Characteristics" should be prioritized
    • Websockets. Pusher has a free tier and might be the choice over the complexity of ActionCable, maybe maybe not
    • Full testing capabilities. Default templates for shared testing?
    • Should be clear and easy how to generate a modern frontend interface through the backend.
    • React? GraphQL? Redux?
    • Open source Design System pre-installed. Material?
    • Code quality is paramount so linters with sane defaults

Command to run:

rails _6.0.0.beta1_ new PROJECTNAME \
  --skip-test \
  --webpack=react \
  --skip-turbolinks \
  --database=postgresql \
  --skip-coffee \
  -m https://gist.githubusercontent.com/sumitngupta/4ee72a44c6d08a45fc6d1a56fb9102cf/raw/601ad1752c497d6570ea0ace0bd2fdd024d0b202/rails-template.rb

rails-template's People

Contributors

sumitngupta avatar

Watchers

 avatar Michael Carey avatar James Cloos avatar

rails-template's Issues

Testing Configuration

  • Rake task to run all specs, frontend and backend.
  • Should be able to run it and have them all pass
  • CI / CD server -- continuous deployment would be sweet.

Frontend Configuration

  • Opinionated frontend - GraphQL? JWT? React (duh), what other libraries?
  • Websockets setup
  • What Yarn packages are default?
  • Install ESLint -- automatically run corrections?
  • Enzyme, ESLint, Jest, faker, why-did-you-update

Ruby Configuration

  • Complete Gem configuration list
  • Finish whats commented out in the doc above
  • Setup Database for local + production
  • Install Rubocop --- automatically run corrections?
  • Ensure all gem installs are done
  • Application.rb configuration

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.