rails_apps_composer: add README files

This commit is contained in:
Torsten Ruger 2016-03-21 18:45:31 +02:00
parent 3876360ec7
commit c4cd472f98
12 changed files with 283 additions and 33 deletions

26
Capfile Normal file
View File

@ -0,0 +1,26 @@
# Load DSL and Setup Up Stages
require 'capistrano/setup'
# Includes default deployment tasks
require 'capistrano/deploy'
# Includes tasks from other gems included in your Gemfile
#
# For documentation on these, see for example:
#
# https://github.com/capistrano/rvm
# https://github.com/capistrano/rbenv
# https://github.com/capistrano/chruby
# https://github.com/capistrano/bundler
# https://github.com/capistrano/rails/tree/master/assets
# https://github.com/capistrano/rails/tree/master/migrations
#
# require 'capistrano/rvm'
# require 'capistrano/rbenv'
# require 'capistrano/chruby'
# require 'capistrano/bundler'
# require 'capistrano/rails/assets'
# require 'capistrano/rails/migrations'
# Loads custom tasks from `lib/capistrano/tasks' if you have any defined.
Dir.glob('lib/capistrano/tasks/*.cap').each { |r| import r }

View File

@ -18,7 +18,6 @@ gem 'coffee-rails', '~> 4.1.0'
# Use jquery as the JavaScript library
gem 'jquery-rails'
# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
gem 'turbolinks'
# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
gem 'jbuilder', '~> 2.0'
# bundle exec rake doc:rails generates the API under doc/api.

62
README Normal file
View File

@ -0,0 +1,62 @@
Web Dev Site
================
Rails Composer is supported by developers who purchase our RailsApps tutorials.
Need help? Ask on Stack Overflow with the tag 'railsapps.'
Problems? Submit an issue: https://github.com/RailsApps/rails_apps_composer/issues
Your application contains diagnostics in this README file.
Please provide a copy of this README file when reporting any issues.
option Build a starter application?
choose Enter your selection: [rails-devise-pundit]
option Get on the mailing list for Rails Composer news?
choose Enter your selection: [none]
option Web server for development?
choose Enter your selection: [puma]
option Web server for production?
choose Enter your selection: [passenger]
option Database used in development?
choose Enter your selection: [sqlite]
option Template engine?
choose Enter your selection: [haml]
option Test framework?
choose Enter your selection: [rspec]
option Continuous testing?
choose Enter your selection: [guard]
option Front-end framework?
choose Enter your selection: [bootstrap3]
option Add support for sending email?
choose Enter your selection: [smtp]
option Authentication?
choose Enter your selection: [devise]
option Devise modules?
choose Enter your selection: [invitable]
option OmniAuth provider?
choose Enter your selection: []
option Authorization?
choose Enter your selection: [pundit]
option Use a form builder gem?
choose Enter your selection: [simple_form]
option Add pages?
choose Enter your selection: [about+users]
option Set a locale?
choose Enter your selection: [none]
option Install page-view analytics?
choose Enter your selection: [ga]
option Add a deployment mechanism?
choose Enter your selection: [capistrano3]
option Set a robots.txt file to ban spiders?
choose Enter your selection: [true]
option Create a GitHub repository? (y/n)
choose Enter your selection: [true]
option Add gem and file for environment variables?
choose Enter your selection: []
option Reduce assets logger noise during development?
choose Enter your selection: [true]
option Improve error reporting with 'better_errors' during development?
choose Enter your selection: [true]
option Use 'pry' as console replacement during development and test?
choose Enter your selection: [false]
option Use or create a project-specific rvm gemset?
choose Enter your selection: [false]

48
README.md Normal file
View File

@ -0,0 +1,48 @@
Web Dev Site
================
This application was generated with the [rails_apps_composer](https://github.com/RailsApps/rails_apps_composer) gem
provided by the [RailsApps Project](http://railsapps.github.io/).
Rails Composer is supported by developers who purchase our RailsApps tutorials.
Problems? Issues?
-----------
Need help? Ask on Stack Overflow with the tag 'railsapps.'
Your application contains diagnostics in the README file. Please provide a copy of the README file when reporting any issues.
If the application doesn't work as expected, please [report an issue](https://github.com/RailsApps/rails_apps_composer/issues)
and include the diagnostics.
Ruby on Rails
-------------
This application requires:
- Ruby 2.2.3
- Rails 4.2.6
Learn more about [Installing Rails](http://railsapps.github.io/installing-rails.html).
Getting Started
---------------
Documentation and Support
-------------------------
Issues
-------------
Similar Projects
----------------
Contributing
------------
Credits
-------
License
-------

View File

@ -1,28 +0,0 @@
== README
This README would normally document whatever steps are necessary to get the
application up and running.
Things you may want to cover:
* Ruby version
* System dependencies
* Configuration
* Database creation
* Database initialization
* How to run the test suite
* Services (job queues, cache servers, search engines, etc.)
* Deployment instructions
* ...
Please feel free to use a different markup language if you do not plan to run
<tt>rake doc:app</tt>.

View File

@ -12,6 +12,5 @@
//
//= require jquery
//= require jquery_ujs
//= require turbolinks
//= require bootstrap-sprockets
//= require_tree .

View File

@ -4,8 +4,8 @@
%meta{:name => "viewport", :content => "width=device-width, initial-scale=1.0"}
%title= content_for?(:title) ? yield(:title) : 'Web Dev Site'
%meta{:name => "description", :content => "#{content_for?(:description) ? yield(:description) : 'Web Dev Site'}"}
= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track' => true
= javascript_include_tag 'application', 'data-turbolinks-track' => true
= stylesheet_link_tag 'application', media: 'all'
= javascript_include_tag 'application'
= csrf_meta_tags
%body
%header

40
config/deploy.rb Normal file
View File

@ -0,0 +1,40 @@
set :application, 'my_app_name'
set :repo_url, 'git@example.com:me/my_repo.git'
# ask :branch, proc { `git rev-parse --abbrev-ref HEAD`.chomp }
# set :deploy_to, '/var/www/my_app'
# set :scm, :git
# set :format, :pretty
# set :log_level, :debug
# set :pty, true
# set :linked_files, %w{config/database.yml}
# set :linked_dirs, %w{bin log tmp/pids tmp/cache tmp/sockets vendor/bundle public/system}
# set :default_env, { path: "/opt/ruby/bin:$PATH" }
# set :keep_releases, 5
namespace :deploy do
desc 'Restart application'
task :restart do
on roles(:app), in: :sequence, wait: 5 do
# Your restart mechanism here, for example:
# execute :touch, release_path.join('tmp/restart.txt')
end
end
after :restart, :clear_cache do
on roles(:web), in: :groups, limit: 3, wait: 10 do
# Here we can do anything such as:
# within release_path do
# execute :rake, 'cache:clear'
# end
end
end
after :finishing, 'deploy:cleanup'
end

View File

@ -0,0 +1,42 @@
set :stage, :production
# Simple Role Syntax
# ==================
# Supports bulk-adding hosts to roles, the primary
# server in each group is considered to be the first
# unless any hosts have the primary property set.
role :app, %w{deploy@example.com}
role :web, %w{deploy@example.com}
role :db, %w{deploy@example.com}
# Extended Server Syntax
# ======================
# This can be used to drop a more detailed server
# definition into the server list. The second argument
# something that quacks like a hash can be used to set
# extended properties on the server.
server 'example.com', user: 'deploy', roles: %w{web app}, my_property: :my_value
# you can set custom ssh options
# it's possible to pass any option but you need to keep in mind that net/ssh understand limited list of options
# you can see them in [net/ssh documentation](http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start)
# set it globally
# set :ssh_options, {
# keys: %w(/home/rlisowski/.ssh/id_rsa),
# forward_agent: false,
# auth_methods: %w(password)
# }
# and/or per server
# server 'example.com',
# user: 'user_name',
# roles: %w{web app},
# ssh_options: {
# user: 'user_name', # overrides user setting above
# keys: %w(/home/user_name/.ssh/id_rsa),
# forward_agent: false,
# auth_methods: %w(publickey password)
# # password: 'please use keys'
# }
# setting per server overrides global ssh_options
# fetch(:default_env).merge!(rails_env: :production)

42
config/deploy/staging.rb Normal file
View File

@ -0,0 +1,42 @@
set :stage, :staging
# Simple Role Syntax
# ==================
# Supports bulk-adding hosts to roles, the primary
# server in each group is considered to be the first
# unless any hosts have the primary property set.
role :app, %w{deploy@example.com}
role :web, %w{deploy@example.com}
role :db, %w{deploy@example.com}
# Extended Server Syntax
# ======================
# This can be used to drop a more detailed server
# definition into the server list. The second argument
# something that quacks like a hash can be used to set
# extended properties on the server.
server 'example.com', user: 'deploy', roles: %w{web app}, my_property: :my_value
# you can set custom ssh options
# it's possible to pass any option but you need to keep in mind that net/ssh understand limited list of options
# you can see them in [net/ssh documentation](http://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start)
# set it globally
# set :ssh_options, {
# keys: %w(/home/rlisowski/.ssh/id_rsa),
# forward_agent: false,
# auth_methods: %w(password)
# }
# and/or per server
# server 'example.com',
# user: 'user_name',
# roles: %w{web app},
# ssh_options: {
# user: 'user_name', # overrides user setting above
# keys: %w(/home/user_name/.ssh/id_rsa),
# forward_agent: false,
# auth_methods: %w(publickey password)
# # password: 'please use keys'
# }
# setting per server overrides global ssh_options
# fetch(:default_env).merge!(rails_env: :staging)

20
public/humans.txt Normal file
View File

@ -0,0 +1,20 @@
/* the humans responsible & colophon */
/* humanstxt.org */
/* TEAM */
<your title>: <your name>
Site:
Twitter:
Location:
/* THANKS */
Daniel Kehoe (@rails_apps) for the RailsApps project
/* SITE */
Standards: HTML5, CSS3
Components: jQuery
Software: Ruby on Rails
/* GENERATED BY */
Rails Composer: http://railscomposer.com/

View File

@ -2,4 +2,4 @@
#
# To ban all spiders from the entire site uncomment the next two lines:
# User-agent: *
# Disallow: /
Disallow: /