Updated setup scripts to include master collections

Author: kaptron

.env.example

@@ -17,6 +17,11 @@ AWS_ACCESS_KEY_ID=XXXX
 AWS_SECRET_ACCESS_KEY=XXXXX
 S3_UPLOADS_BUCKET=shape-uploads-production
 
+# required Collection IDs (replace with your master collections or run rails db:seed with these values)
+GETTING_STARTED_TEMPLATE_ID=100
+ORG_MASTER_TEMPLATES_ID=200
+
+
 # monitoring
 APPSIGNAL_APP_NAME=shape
 APPSIGNAL_PUSH_API_KEY=xxxxxxxx

README.md

@@ -30,22 +30,24 @@ gem install bundler
 - https://github.com/ideo/network-react-components
 - https://github.com/ideo/network-api-ruby
 
-**Clone the app and install the gems:**
+**Clone the app and run the setup script:**
+
+Note: `./dev.sh -s` will run `rails db:setup` which will also seed your database with two required collections, marked by the following `ENV` ids:
+
+- `ENV['GETTING_STARTED_TEMPLATE_ID']`
+- `ENV['ORG_MASTER_TEMPLATES_ID']`
+
+If these two collections don't exist then you won't be able to create a new organization and setup your first account.
 
 ```
 git clone https://github.com/ideo/shape
 cd shape
+# Setup the `.env` file with valid credentials: (get these from the IDEO team)
+cp .env.example .env
 # run our setup script (install gems, packages, setup database)
 ./dev.sh -s
 ```
 
-**Setup the `.env` file with valid credentials:**
-
-```
-cp .env.example .env
-# modify credentials
-```
-
 **Setup your text editor and linter:**
 
 Ensure your text editor has [eslint](https://eslint.org/) and [rubocop](https://rubocop.readthedocs.io/en/latest/) installed (e.g. for Atom you would install [linter-eslint](https://github.com/AtomLinter/linter-eslint) and [linter-rubocop](https://atom.io/packages/linter-rubocop)). For JS code we are using [prettier](https://prettier.io/), so if you have your linter running, it will automatically format properly on save.

db/seeds.rb

@@ -5,3 +5,32 @@
 #
 #   movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
 #   Character.create(name: 'Luke', movie: movies.first)
+
+org = Organization.find_or_create_by(id: 1)
+if ENV['GETTING_STARTED_TEMPLATE_ID']
+  c = Collection.find_or_initialize_by(
+    id: ENV['GETTING_STARTED_TEMPLATE_ID'],
+  )
+  if c.new_record?
+    c.name = 'Seeded Content for My Collection'
+    c.organization = org
+    c.save
+
+    # just to give it one item
+    FactoryBot.create(:collection_card_text, parent: c)
+  end
+end
+
+if ENV['ORG_MASTER_TEMPLATES_ID']
+  c = Collection.find_or_initialize_by(
+    id: ENV['ORG_MASTER_TEMPLATES_ID'],
+  )
+  if c.new_record?
+    c.name = 'Master Templates'
+    c.organization = org
+    c.save
+
+    # just to give it one template
+    FactoryBot.create(:collection, master_template: true, num_cards: 1, parent_collection: c)
+  end
+end

script/dev-setup

@@ -21,8 +21,6 @@ if [ ! -f "$DIR/.env" ]; then
 fi
 
 yarn install
-
 bundle install
-
+# setup runs db:create, db:schema:load and db:seed
 bin/rails db:setup
-bin/rails db:migrate