mirror of
https://github.com/edcommonwealth/sqm-dashboards.git
synced 2026-03-07 21:48:16 -08:00
Update README document for start up instructions.
This commit is contained in:
parent
1699d65cc0
commit
5bed6bfcea
2 changed files with 18 additions and 12 deletions
|
|
@ -110,11 +110,15 @@ GEM
|
|||
mini_mime (>= 0.1.1)
|
||||
method_source (1.0.0)
|
||||
mini_mime (1.1.1)
|
||||
mini_portile2 (2.6.1)
|
||||
minitest (5.14.4)
|
||||
multi_json (1.15.0)
|
||||
nested_scaffold (1.1.0)
|
||||
newrelic_rpm (8.0.0)
|
||||
nio4r (2.5.8)
|
||||
nokogiri (1.12.4)
|
||||
mini_portile2 (~> 2.6.1)
|
||||
racc (~> 1.4)
|
||||
nokogiri (1.12.4-x86_64-darwin)
|
||||
racc (~> 1.4)
|
||||
nokogiri (1.12.4-x86_64-linux)
|
||||
|
|
@ -243,6 +247,7 @@ GEM
|
|||
nokogiri (~> 1.8)
|
||||
|
||||
PLATFORMS
|
||||
ruby
|
||||
x86_64-darwin-20
|
||||
x86_64-linux
|
||||
|
||||
|
|
|
|||
23
README.md
23
README.md
|
|
@ -9,6 +9,15 @@ This is a Rails project, deployed on Heroku.
|
|||
|
||||
|
||||
## Local development
|
||||
Install Postgres and running first.
|
||||
|
||||
(MacOS, Optional), you can use Homebrew:
|
||||
```
|
||||
$ brew install postgres
|
||||
$ brew services start postgresql
|
||||
```
|
||||
|
||||
Once postgres is installed and running, install the required gems and then migrate the database.
|
||||
```
|
||||
$ bundle install
|
||||
$ bundle exec rake db:create db:migrate db:seed
|
||||
|
|
@ -28,22 +37,14 @@ You can load these into the database and index them for use in the webapp by run
|
|||
|
||||
You can start by generating fake data:
|
||||
```
|
||||
$ bundle exec rake data:generate
|
||||
$ bundle exec rake db:fixtures:load
|
||||
```
|
||||
|
||||
Loading all the real response data take a while, so you can start by loading only a sample of the data for one particular school with:
|
||||
|
||||
## Running tests
|
||||
```
|
||||
$ bundle exec rake data:load_sample
|
||||
$ bundle exec rake test
|
||||
```
|
||||
|
||||
This loads all the data:
|
||||
|
||||
```
|
||||
$ bundle exec rake data:load
|
||||
```
|
||||
|
||||
|
||||
## Demo deploy
|
||||
Get the code and make a new repo without any history.
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue