From 311e0ff68e35ee74dec8269d6849fe122178397d Mon Sep 17 00:00:00 2001 From: David Diaz Date: Fri, 28 Apr 2017 15:47:58 -0500 Subject: [PATCH 1/5] topic: I just onboarded and wanted to update the readme to address a few issues. --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a06f47a43..9a031e820 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,8 @@ Copy and rename the example `.env.example` file as `.env` and modify it to match For a rudimentary setup, these variables should be configured: -* Use `$ rake secret` to generate `APP_SECRET` and `DEVISE_SECRET` +* Use `$ bundle rails secret` to generate `APP_SECRET` and `DEVISE_SECRET` +* To generate the two tokens for `APP_SECRET` and `DEVISE_SECRET`, simply run the above formula twice * If the superuser isn't used for the app databases, the `DATABASE_USERNAME` and `DATABASE_PASSWORD` should be set accordingly. * Set `HOST` to the local Web server's root URL to properly configure Fog (local asset storage) @@ -312,6 +313,10 @@ If a consuming or companion application would like to produce Cortex-equivalent * [CB1 Lander Shell](https://github.com/cbdr/cb1-lander-shell) - Platform for hosting lander pages and experiments, utilizing Cortex Posts and Sinatra. [Live Site](http://corporate.careerbuilder.com/) * [CareerBuilder.com](https://github.com/cbdr/consumer-main) - The main Consumer Web site for CB.com uses Cortex Posts for the [Privacy](http://www.careerbuilder.com/privacy) and [Terms of Service](http://www.careerbuilder.com/terms) pages. +## Some Notes +* Ensure you have read / write access to your project directory during installation. +* Run `npm -v` to make sure node is properly linked. If the command is not found, chances are the correct version of node is not linked. Run `brew link node`. + ## Contributing Anyone and everyone is encouraged to fork Cortex and submit pull requests, propose new features and create issues. From 9657e855e8c16bd167d0f8d842e14d605c807e62 Mon Sep 17 00:00:00 2001 From: David Diaz Date: Fri, 28 Apr 2017 15:50:48 -0500 Subject: [PATCH 2/5] topic: Updating table of contents for some notes. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 9a031e820..20ec4596b 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,7 @@ Cortex follows a decentralized, API-only architecture - it is *not* built like W - [Webpages and Snippets](#webpages-and-snippets) - [Exceptions](#exceptions) - [Applications Using Cortex](#applications-using-cortex) +- [Some Notes](#some-notes) - [Contributing](#contributing) - [License](#license) - [Copyright](#copyright) From ba5f9c7b6c699e6468135a8e9e7f3331b913e098 Mon Sep 17 00:00:00 2001 From: David Diaz Date: Fri, 28 Apr 2017 16:49:53 -0500 Subject: [PATCH 3/5] topic: Changing 'Some Notes' to 'Troubleshooting'. Updating table of contents. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 20ec4596b..8de1c7462 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ Cortex follows a decentralized, API-only architecture - it is *not* built like W - [Webpages and Snippets](#webpages-and-snippets) - [Exceptions](#exceptions) - [Applications Using Cortex](#applications-using-cortex) -- [Some Notes](#some-notes) +- [Troubleshooting](#troubleshooting) - [Contributing](#contributing) - [License](#license) - [Copyright](#copyright) @@ -314,7 +314,7 @@ If a consuming or companion application would like to produce Cortex-equivalent * [CB1 Lander Shell](https://github.com/cbdr/cb1-lander-shell) - Platform for hosting lander pages and experiments, utilizing Cortex Posts and Sinatra. [Live Site](http://corporate.careerbuilder.com/) * [CareerBuilder.com](https://github.com/cbdr/consumer-main) - The main Consumer Web site for CB.com uses Cortex Posts for the [Privacy](http://www.careerbuilder.com/privacy) and [Terms of Service](http://www.careerbuilder.com/terms) pages. -## Some Notes +## Troubleshooting * Ensure you have read / write access to your project directory during installation. * Run `npm -v` to make sure node is properly linked. If the command is not found, chances are the correct version of node is not linked. Run `brew link node`. From 5988f957b8b0e48b7e0ae9f26a06ee70712a53e7 Mon Sep 17 00:00:00 2001 From: David Diaz Date: Mon, 1 May 2017 10:21:49 -0500 Subject: [PATCH 4/5] doc: updating command to generate auth keys from 'bundle rails' to 'bundle exec rails' --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8de1c7462..ae67af32e 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,7 @@ Copy and rename the example `.env.example` file as `.env` and modify it to match For a rudimentary setup, these variables should be configured: -* Use `$ bundle rails secret` to generate `APP_SECRET` and `DEVISE_SECRET` +* Use `$ bundle exec rails secret` to generate `APP_SECRET` and `DEVISE_SECRET` * To generate the two tokens for `APP_SECRET` and `DEVISE_SECRET`, simply run the above formula twice * If the superuser isn't used for the app databases, the `DATABASE_USERNAME` and `DATABASE_PASSWORD` should be set accordingly. * Set `HOST` to the local Web server's root URL to properly configure Fog (local asset storage) From f87c9352f18af90930f3ad171834514ce94a384d Mon Sep 17 00:00:00 2001 From: David Diaz Date: Mon, 1 May 2017 11:44:50 -0500 Subject: [PATCH 5/5] doc: reorged troubleshooting section of Cortex readme; merged line regarding generating secret keys twice in environment section --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ae67af32e..ba87c0e9b 100644 --- a/README.md +++ b/README.md @@ -56,8 +56,7 @@ Copy and rename the example `.env.example` file as `.env` and modify it to match For a rudimentary setup, these variables should be configured: -* Use `$ bundle exec rails secret` to generate `APP_SECRET` and `DEVISE_SECRET` -* To generate the two tokens for `APP_SECRET` and `DEVISE_SECRET`, simply run the above formula twice +* Execute `$ bundle exec rails secret` twice to generate both an `APP_SECRET` and `DEVISE_SECRET` * If the superuser isn't used for the app databases, the `DATABASE_USERNAME` and `DATABASE_PASSWORD` should be set accordingly. * Set `HOST` to the local Web server's root URL to properly configure Fog (local asset storage) @@ -315,8 +314,7 @@ If a consuming or companion application would like to produce Cortex-equivalent * [CareerBuilder.com](https://github.com/cbdr/consumer-main) - The main Consumer Web site for CB.com uses Cortex Posts for the [Privacy](http://www.careerbuilder.com/privacy) and [Terms of Service](http://www.careerbuilder.com/terms) pages. ## Troubleshooting -* Ensure you have read / write access to your project directory during installation. -* Run `npm -v` to make sure node is properly linked. If the command is not found, chances are the correct version of node is not linked. Run `brew link node`. +* For OS X / homebrew users: Run `which node` to ensure node is properly linked. The path shown should match homebrew's default installation path (run `which brew` to reveal this). If its not, then run `brew link node` and follow the instructions. ## Contributing