thredded_create_app 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79d691805cc0dd79223c86c6c8df35520dd93253
-  data.tar.gz: 43b887ec2b346f222e0a707e0c8e4b91f969143e
+  metadata.gz: 43c529c88409832930c874c409f84ac7e5f6cb44
+  data.tar.gz: 4aea74c5015e106db8602531cd736ace9ea6aa3f
 SHA512:
-  metadata.gz: 35a0fdff1b86d5e17bc0404da332c38d830c8d626286cd82aa1db8275deb80c7979e3a79d6b9ea671e85d69fabce5aade276e494051197e002406cbc23944bc5
-  data.tar.gz: e737e4755bedbb0a905f07ee979b005b4ef3f26cbfa4369944244fbc6bc8cb73ff1fac269bcb72d19f029083785fe3a9665cbef130e4c5c6e31e2a84e430d491
+  metadata.gz: 5c893690c830442227d0e27b9f52877ef4e454ce72356beafe6395dc7ecce129b61d80cb230f4e390798099710fbbe028b05a426c70dba58891dda6223177eff
+  data.tar.gz: 40c96f6b87029f670ce5c37c26534ab237ab9e7900ac137d529b22dd24bdaa09c2e64b8c62447d978dfb36f0380c377e81ae9663ed45e95ae63377c2340ca06c

data/README.md

@@ -23,12 +23,41 @@ Example screenshots of the generated app:
 2. A supported database: PostgreSQL (recommended), MySQL v5.7+, or SQLite.
 3. Ruby 2.3+.
 
+You may also need some packages to compile Thredded dependencies.
+On Ubuntu, you can install all the required packages by running:
+
+```bash
+sudo apt-get install autoconf automake bison build-essential gawk git \
+  libffi-dev libgdbm-dev libgmp-dev libncurses5-dev libpq-dev libreadline6-dev \
+  libsqlite3-dev libtool libyaml-dev nodejs pkg-config ruby sqlite3
+```
+
 ## Usage
 
 Install the gem and create your app:
 
 ```bash
 gem install thredded_create_app
+```
+
+#### Installing the gem using system Ruby
+
+When using the *system* Ruby on Mac or Linux (as opposed to RVM or rbenv),
+the command above will fail because only root can install gems system-wide.
+
+Instead, install `thredded_create_app` with the `--user` flag:
+
+```bash
+gem install --user thredded_create_app
+```
+
+The above will install the gem to the `~/.gem/` directory.
+
+Then, [add the user gems `bin` directory to `PATH`](http://guides.rubygems.org/faqs/#user-install).
+
+### Create your app
+
+```
 thredded_create_app myapp
 ```
 
@@ -39,27 +68,6 @@ or `--datase mysql2` for MySQL.
 Run `thredded_create_app --help` for more information about the available
 options.
 
-### RVM
-
-If you're using [RVM](https://rvm.io/), you probably want to create a
-gemset before creating your app:
-
- ```bash
- RUBY_VERSION=2.3.1 APP=myapp
- rvm use --create "${RUBY_VERSION}@${APP}"
- gem install thredded_create_app
- thredded_create_app "$APP"
- ```
-   
-Then, generate the `.ruby-version` and `.ruby-gemset` files so that the gemset
-is used automatically whenever you `cd` into the project directory:
- 
- ```bash
- cd "$APP"
- rvm use --ruby-version "${RUBY_VERSION}@${APP}"
- printf '.ruby-version\n.ruby-gemset\n' >> .git/info/exclude
- ```
-
 ### App generation
 
 The app generator will do the steps below for you.
@@ -150,6 +158,31 @@ by tweeting [@thredded]!
 [Thredded chat room]: https://gitter.im/thredded/thredded
 [Thredded Readme]: https://github.com/thredded/thredded/blob/master/README.md
 
+## Deploying to Heroku
+
+To deploy your app to Heroku, run:
+
+```bash
+gem install heroku # --user if using system ruby
+# Create a heroku app and set the necessary environment variables
+heroku create
+heroku config:set RACK_ENV=production RAILS_ENV=production \
+  SECRET_KEY_BASE="$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1)"
+# Deploy to heroku
+git push heroku master
+# Set up the database and some seed data (an admin user and a messageboard)
+heroku run rake db:migrate db:seed
+# Open the website in your default browser
+heroku open
+```
+
+You can log in as the admin user with email `admin@<app name>.com`, password
+`123456`.
+
+The app is now deployed, but you'll also need to set up emailing, either by
+using one of the Heroku add-ons (there are some free ones), or by
+[configuring it yourself](http://guides.rubyonrails.org/action_mailer_basics.html#action-mailer-configuration).
+
 ## Development
 
 The instructions below are for developing and contributing to

data/lib/thredded_create_app/cli.rb

@@ -2,6 +2,7 @@
 require 'thredded_create_app/command_error'
 require 'thredded_create_app/generator'
 require 'thredded_create_app/logging'
+require 'thredded_create_app/version'
 
 require 'highline'
 module ThreddedCreateApp

data/lib/thredded_create_app/generator.rb

@@ -85,7 +85,9 @@ module ThreddedCreateApp
                   ("path: '#{path}'" if path)].compact.join(', ')
         end
       end
-      run "bundle install#{' --quiet' unless verbose?}"
+      log_info 'Installing gems'
+      run "bundle install#{' --quiet' unless verbose?}" \
+          "#{' --path .bundle' unless File.writable?(Gem.dir)}"
       git_commit "Add gems: #{gems.map { |(name, *)| name } * ', '}"
     end
   end

data/lib/thredded_create_app/tasks/add_display_name_to_users.rb

@@ -68,7 +68,7 @@ module ThreddedCreateApp
   before_validation :uniq_display_name!, on: :create
 
   def display_name=(value)
-    super(value&.strip)
+    super(value ? value.strip : nil)
   end
 
         RUBY

data/lib/thredded_create_app/tasks/create_rails_app.rb

@@ -15,8 +15,10 @@ module ThreddedCreateApp
 
       def before_bundle
         if @install_gem_bundler_rails
-          run 'gem update --system --no-document --quiet'
-          run 'gem install bundler rails --no-document'
+          user_install = !File.writable?(Gem.dir)
+          run 'gem update --system --no-document --quiet' unless user_install
+          run 'gem install bundler rails --no-document' \
+              "#{' --user' if user_install}"
         end
         # I have no idea why this bundle exec is necessary on Travis.
         run "#{'bundle exec ' if ENV['TRAVIS']}" \

data/lib/thredded_create_app/tasks/setup_app_skeleton/home_show.html.erb.erb

@@ -1,14 +1,13 @@
 <h1>Welcome to your new Rails app with Thredded! 🎉</h1>
 
+<p>Check out the
+  <b><%%= link_to t('nav.forums'), thredded.root_path %></b>.
+</p>
+
 <%% unless Rails.env.production? %>
   <p>You can now:</p>
 
   <ul>
-    <li>
-      <p>Check out the
-        <b><%%= link_to t('nav.forums'), thredded.root_path %></b>.
-      </p>
-    </li>
     <li>
       <p>
         <b><%%= link_to 'Log in', new_user_session_path %></b> as

data/lib/thredded_create_app/tasks/setup_app_skeleton/seeds.rb.erb

@@ -14,7 +14,7 @@ messageboard = Thredded::Messageboard.create!(
 
 Thredded::TopicForm.new(
     title: 'My first topic',
-    content: <<~MARKDOWN,
+    content: <<-MARKDOWN,
 Hello **world**! :smile: This first post shows some of the Thredded default post
 formatting functionality.
 

data/lib/thredded_create_app/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module ThreddedCreateApp
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thredded_create_app
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Gleb Mazovetskiy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-02 00:00:00.000000000 Z
+date: 2017-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor