Skip to content

Commit c644d00

Browse files
Updated README.md (#39)
Co-authored-by: Sean Marcia <[email protected]>
1 parent 11ae21b commit c644d00

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,56 @@ SkillRX is one of many projects initiated and run by Ruby for Good. You can find
1111
# Welcome Contributors!
1212
Thank you for checking out our work. We are in the process of setting up the repository, roadmap, values, and contribution guidelines for the project. We will be adding issues and putting out a call for contributions soon.
1313

14+
[Contribution guidelines for this project](CONTRIBUTING.md)
15+
16+
17+
# Install & Setup
18+
19+
Clone the codebase
20+
```
21+
git clone [email protected]:rubyforgood/skillrx.git
22+
```
23+
24+
Run the setup script to prepare DB and assets
25+
```sh
26+
bin/setup
27+
```
28+
29+
To run the app locally, use:
30+
```
31+
bin/dev
32+
```
33+
34+
To update dependencies in Gemfile, use:
35+
```
36+
bundle install
37+
```
38+
39+
You should see the seed organization by going to:
40+
```
41+
http://localhost:3000/
42+
```
43+
44+
45+
# Running specs
46+
47+
```sh
48+
# Default: Run all spec files (i.e., those matching spec/**/*_spec.rb)
49+
$ bundle exec rspec
50+
51+
# Run all spec files in a single directory (recursively)
52+
$ bundle exec rspec spec/models
53+
54+
# Run a single spec file
55+
$ bundle exec rspec spec/controllers/accounts_controller_spec.rb
56+
57+
# Run a single example from a spec file (by line number)
58+
$ bundle exec rspec spec/controllers/accounts_controller_spec.rb:8
59+
60+
# See all options for running specs
61+
$ bundle exec rspec --help
62+
```
63+
1464
# Setup
1565

1666
Clone this repo and run `bin/setup`. Run `bin/dev` or `bin/server` (if you like Overmind) to start working with app.

0 commit comments

Comments
 (0)