Skip to content

Commit e174080

Browse files
committed
Update README
1 parent 4109ad6 commit e174080

2 files changed

Lines changed: 28 additions & 31 deletions

File tree

README.md

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,17 @@
22

33
## Standard Workflow
44

5-
1. Fork to your own account.
6-
1. Clone to your computer.
7-
1. In the GitHub Desktop app, [create a branch for your work](https://help.github.com/desktop/guides/contributing/creating-a-branch-for-your-work/#creating-a-branch).
8-
1. Open the entire folder you downloaded in Atom.
5+
1. Fork the repo to your own account, if it isn't already.
6+
1. Create a Cloud9 workspace [as described here](https://guides.firstdraft.com/getting-started-with-cloud-9.html).
7+
1. Click the Gear icon in the top-right corner of the Workspace to get to the Settings pane, find the Experimental section, **turn on Auto-Save**, and refresh Cloud 9.
8+
1. Run the command `bin/setup` in the Terminal at the bottom of the window.
9+
1. Click the "Run Project" button at the top of the window.
10+
1. In a Chrome tab, check out the live app at https://[PROJECT NAME]-[YOUR CLOUD 9 USERNAME].c9users.io
11+
1. Navigate to https://[PROJECT NAME]-[YOUR CLOUD 9 USERNAME].c9users.io/rails/git
12+
1. Create a branch for your work.
913
1. Make your first change to the code. (You could modify this `README.md` file by adding your username next to the project in the heading, for example.)
10-
1. In the GitHub Desktop app, create a commit. You *must* type a "summary"; "description" is optional.
11-
1. Click Publish. Verify that your branch is now visible on your fork at GitHub.com in the "Branch" dropdown.
12-
1. **Commit and Sync often as you work.**
13-
1. Make new branches freely to experiment! You can always switch back to an older branch using the dropdown in the Desktop App, and all of your files will instantly snap back to their older state. **So, when in doubt, create a branch**, _especially_ before starting on a new task.
14-
1. You don't need to merge back into your master branch; in the end, just stay on whatever your best branch is. (In the real world, you would ultimately merge your best branch back into your master branch and deploy it to your production server.)
15-
1. Run `rails grade` as often as you like to see how you are doing.
16-
1. You can push commits and `rails grade` right up until the due date.
17-
1. If you have a question about your code, a great way to get feedback is to open a [Pull Request](https://help.github.com/articles/creating-a-pull-request/). After creating it, if you include the URL of your Pull Request when you post your question, reviewers will be able to easily see the changes you've made and leave comments on each line of your code with suggestions.
18-
19-
## Project Specific Instructions
20-
21-
1. `cd` into the folder you downloaded.
22-
1. `bundle install` (or `bundle` for short)
23-
1. `rails server` (or `rails s` for short)
14+
1. Create a commit.
15+
1. Click Push to GitHub.
16+
1. **Commit and Push often as you work.**
17+
1. Make new branches freely to experiment! You can always switch back to an older branch, and all of your files will instantly snap back to their older state. **So, when in doubt, create a branch**, _especially_ before starting on a new task.
18+
1. A great way to get feedback is to "Open a pull request". That will make it easy to see the changes you've made in the branch, and we can leave line-by-line comments.

bin/setup

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,32 +14,34 @@ chdir APP_ROOT do
1414
# This script is a starting point to setup your application.
1515
# Add necessary setup steps to this file.
1616

17-
puts "\n== Upgrading Ruby =="
18-
system! 'rvm install 2.3.4'
19-
system! 'rvm use 2.3.4 --default'
17+
puts "== Upgrading Ruby =="
18+
system! "rvm install 2.3.4"
19+
# system! "rvm use 2.3.4 --default"
20+
system! "rvm alias create default 2.3.4"
2021

21-
puts '== Installing dependencies =='
22-
system! 'gem install bundler --conservative'
23-
system('bundle check') || system!('bundle install')
22+
23+
puts "\n== Installing dependencies =="
24+
system! "gem install bundler --conservative"
25+
system("bundle check") || system!("bundle install")
2426

2527
# Install JavaScript dependencies if using Yarn
26-
# system('bin/yarn')
28+
# system("bin/yarn")
2729

2830

2931
# puts "\n== Copying sample files =="
30-
# unless File.exist?('config/database.yml')
31-
# cp 'config/database.yml.sample', 'config/database.yml'
32+
# unless File.exist?("config/database.yml")
33+
# cp "config/database.yml.sample", "config/database.yml"
3234
# end
3335

3436
puts "\n== Preparing database =="
35-
system! 'bin/rails db:setup'
37+
system! "bin/rails db:setup"
3638

3739
puts "\n== Removing old logs and tempfiles =="
38-
system! 'bin/rails log:clear tmp:clear'
40+
system! "bin/rails log:clear tmp:clear"
3941

4042
puts "\n== Restarting application server =="
41-
system! 'bin/rails restart'
43+
system! "bin/rails restart"
4244

4345
puts "\n== Installing diff2html-cli =="
44-
system! 'npm install -g diff2html-cli'
46+
system! "npm install -g diff2html-cli"
4547
end

0 commit comments

Comments
 (0)