add README

This commit is contained in:
Armando Fox 2016-04-03 16:15:43 -07:00
parent 44944438d0
commit e01e1c6aec
4 changed files with 84 additions and 28 deletions

View File

@ -32,9 +32,14 @@ gem 'sdoc', '~> 0.4.0', group: :doc
# Use Capistrano for deployment
# gem 'capistrano-rails', group: :development
gem 'themoviedb'
group :development, :test do
# Call 'byebug' anywhere in the code to stop execution and get a debugger console
gem 'byebug'
gem 'rspec-rails'
gem 'guard-rspec'
# Use sqlite3 as the database for Active Record
gem 'sqlite3'

View File

@ -45,6 +45,7 @@ GEM
builder (3.2.2)
byebug (5.0.0)
columnize (= 0.9.0)
coderay (1.1.0)
coffee-rails (4.1.0)
coffee-script (>= 2.2.0)
railties (>= 4.0.0, < 5.0)
@ -57,10 +58,29 @@ GEM
diff-lcs (1.2.5)
erubis (2.7.0)
execjs (2.5.2)
ffi (1.9.10)
formatador (0.2.5)
globalid (0.3.6)
activesupport (>= 4.1.0)
guard (2.13.0)
formatador (>= 0.2.4)
listen (>= 2.7, <= 4.0)
lumberjack (~> 1.0)
nenv (~> 0.1)
notiffany (~> 0.0)
pry (>= 0.9.12)
shellany (~> 0.0)
thor (>= 0.18.1)
guard-compat (1.2.1)
guard-rspec (4.6.4)
guard (~> 2.1)
guard-compat (~> 1.1)
rspec (>= 2.99.0, < 4.0)
haml (4.0.6)
tilt
httparty (0.13.7)
json (~> 1.8)
multi_xml (>= 0.5.2)
i18n (0.7.0)
jbuilder (2.3.1)
activesupport (>= 3.0.0, < 5)
@ -70,17 +90,31 @@ GEM
railties (>= 4.2.0)
thor (>= 0.14, < 2.0)
json (1.8.3)
listen (3.0.5)
rb-fsevent (>= 0.9.3)
rb-inotify (>= 0.9)
loofah (2.0.2)
nokogiri (>= 1.5.9)
lumberjack (1.0.10)
mail (2.6.3)
mime-types (>= 1.16, < 3)
method_source (0.8.2)
mime-types (2.6.1)
mini_portile (0.6.2)
minitest (5.8.0)
multi_json (1.11.2)
multi_xml (0.5.5)
nenv (0.2.0)
nokogiri (1.6.6.2)
mini_portile (~> 0.6.0)
notiffany (0.0.8)
nenv (~> 0.1)
shellany (~> 0.0)
pg (0.18.2)
pry (0.10.3)
coderay (~> 1.1.0)
method_source (~> 0.8.1)
slop (~> 3.4)
rack (1.6.4)
rack-test (0.6.3)
rack (>= 1.0)
@ -114,7 +148,14 @@ GEM
rake (>= 0.8.7)
thor (>= 0.18.1, < 2.0)
rake (10.4.2)
rb-fsevent (0.9.7)
rb-inotify (0.9.6)
ffi (>= 0.5.0)
rdoc (4.2.0)
rspec (3.3.0)
rspec-core (~> 3.3.0)
rspec-expectations (~> 3.3.0)
rspec-mocks (~> 3.3.0)
rspec-core (3.3.2)
rspec-support (~> 3.3.0)
rspec-expectations (3.3.1)
@ -142,6 +183,8 @@ GEM
sdoc (0.4.1)
json (~> 1.7, >= 1.7.7)
rdoc (~> 4.0)
shellany (0.0.1)
slop (3.6.0)
spring (1.3.6)
sprockets (3.2.0)
rack (~> 1.0)
@ -150,6 +193,8 @@ GEM
activesupport (>= 3.0)
sprockets (>= 2.8, < 4.0)
sqlite3 (1.3.10)
themoviedb (1.0.0)
httparty
thor (0.19.1)
thread_safe (0.3.5)
tilt (1.4.1)
@ -173,6 +218,7 @@ DEPENDENCIES
autotest
byebug
coffee-rails (~> 4.1.0)
guard-rspec
haml
jbuilder (~> 2.0)
jquery-rails
@ -184,6 +230,7 @@ DEPENDENCIES
sdoc (~> 0.4.0)
spring
sqlite3
themoviedb
turbolinks
uglifier (>= 1.3.0)
web-console (~> 2.0)

32
README.md Normal file
View File

@ -0,0 +1,32 @@
# RottenPotatoes demo app: getting started
This app is associated with the free [online
course](http://www.saas-class.org) and (non-free)
[ebook](http://www.saasbook.info) Engineering Software as a Service.
To get started:
0. [Setup a Cloud9
environment](https://github.com/saasbook/courseware/wiki/Setting-up-Cloud9)
for the course.
0. Fork this repository to your own GitHub account, using the "Fork"
button in the upper right corner of this page. It's fine to make the
forked copy public.
0. In your Cloud9 terminal, type the following command to clone your
copy of the repository to your development workspace:
`git clone git@github.com:YourGithubUsername/rottenpotatoes-rails-intro.git`
0. Then `cd rottenpotatoes-rails-intro` to change to the app's
directory.
0. Run the command `bundle install` to make sure all the gems
(libraries) used by the app are in place.
0. Run `bundle exec rake db:setup` to create the initial database.
0. Run `rails server -p $PORT -b $IP` to start the app. Cloud9 will pop
up a window showing the URL to visit in your browser to interact with
the running app.

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>.