Hyperstack
  • Welcome
  • Rails Installation and Configuration
    • Prerequisites
    • Using the Hyperstack Installer
    • Using the Generators
    • File Structure
    • Routing and Mounting Components
    • Other Rails Configuration Details
    • Why Rails? Other Frameworks?
  • HyperComponent
    • Component Classes
    • HTML Tags & CSS Classes
    • Component Children, Keys and Fragments
    • Component Params
    • Lifecycle Methods
    • Component State
    • Events and Callbacks
    • Interlude: Tic Tac Toe
    • Recovering from Errors
    • JavaScript Components
    • Elements and Rendering
    • Summary of Methods
    • List of Predefined Tags & Components
    • Predefined Events
    • Notes
    • Further Reading
  • HyperState
  • HyperRouter
  • HyperModel
  • Operations
  • Policies
  • Internationalization
  • Development Tools, Workflow and Procedures
    • Debugging
    • HyperTrace
    • HyperSpec
      • Installation
      • Tutorial
      • Methods and Features
      • Using with Rack
    • Deploy To Heroku
  • Tutorial
    • TodoMVC Tutorial Part I
    • TodoMVC Tutorial Part II
  • Community
Powered by GitBook
On this page
  • Start the Rails app
  • Installer Options

Was this helpful?

  1. Rails Installation and Configuration

Using the Hyperstack Installer

In the directory of your existing or newly created Rails app:

  • add gem 'rails-hyperstack', "~> 1.0.alpha1.0" to your Gemfile

  • run bundle install

  • run bundle exec rails hyperstack:install

Note: if you want to use the unreleased edge branch your gem specification will be:

gem 'rails-hyperstack',
     git: 'git://github.com/hyperstack-org/hyperstack.git',
     branch: 'edge',
     glob: 'ruby/*/*.gemspec'

HOWEVER currently we are doing weekly alpha updates, you should not need to do this.

Start the Rails app

  • bundle exec foreman start to start Rails and the Hotloader

  • Navigate to http://localhost:5000/

You will see an empty page with the word "App" displayed.

Open your editor and find the file /app/hyperstack/components/app.rb

Change the 'App' to 'Hello World' and save the file.

You should see the page on the browser change to "Hello World"

You are in business!

Installer Options

You can control what gets installed with the following options:

bundle exec rails hyperstack:install:webpack          # just add webpack
bundle exec rails hyperstack:install:skip-webpack     # all but webpack
bundle exec rails hyperstack:install:hyper-model      # just add hyper-model
bundle exec rails hyperstack:install:skip-hyper-model # all but hyper-model
bundle exec rails hyperstack:install:hotloader        # just add the hotloader
bundle exec rails hyperstack:install:skip-hotloader   # skip the hotloader

Note that the :webpack and :skip-webpack options control whether the installer will add the webpacker Gem. If webpacker is already installed in the Gemfile then the installer will always integrate with webpacker.

PreviousPrerequisitesNextUsing the Generators

Last updated 4 years ago

Was this helpful?

If this does not work, please contact us on , or

slack
create an issue on github.