Skip to content

Revisions and Updates for Readme #490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
toastercup merged 6 commits into from
May 19, 2017
Merged

Revisions and Updates for Readme #490

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
311e0ff
topic: I just onboarded and wanted to update the readme to address a …
Apr 28, 2017
9657e85
topic: Updating table of contents for some notes.
Apr 28, 2017
ba5f9c7
topic: Changing 'Some Notes' to 'Troubleshooting'. Updating table of …
Apr 28, 2017
5988f95
doc: updating command to generate auth keys from 'bundle rails' to 'b…
May 1, 2017
f87c935
doc: reorged troubleshooting section of Cortex readme; merged line re…
May 1, 2017
db9249a
Merge branch 'develop' into topic/april-2017-readme-updates
May 19, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
- [Troubleshooting](#troubleshooting)
- [Contributing](#contributing)
- [License](#license)
- [Copyright](#copyright)
Expand All @@ -55,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 `$ rake secret` to generate `APP_SECRET` and `DEVISE_SECRET`
* 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)

Expand Down Expand Up @@ -312,6 +313,9 @@ 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.

## Troubleshooting
* 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

Anyone and everyone is encouraged to fork Cortex and submit pull requests, propose new features and create issues.
Expand Down