From fd343db950c514848e366938cd84daa6b1a1094e Mon Sep 17 00:00:00 2001 From: Andy Zhao Date: Thu, 26 Apr 2018 22:45:26 -0400 Subject: [PATCH] Update readme with new API key instructions (#252) --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 81385e207..02f7de835 100644 --- a/README.md +++ b/README.md @@ -76,8 +76,8 @@ If a process could be improved, don't hesitate to bring it up, but there are alw 5. Set up your environment variables/secrets - Create a `config/application.yml` file to store development secrets. This is a personal file that is ignored in git. - Copy [`config/sample_application.yml`](config/sample_application.yml) in order to create a valid `application.yml` - - If you are missing `ENV` variables on bootup, `_env_checker.rb` will let you know. If you add or remove `ENV` vars to the project, you must also modify this file before they can be merged. - - You can start the app in development with basic placeholder keys, but you will need to provide your own valid keys for a lot of app behavior (such as logging in via oauth). + - You'll need to get your own free API keys for a few services. [**Follow this wiki to get them.**](https://github.com/thepracticaldev/dev.to_core/wiki/Getting-API-Keys-for-Basic-Development) + - If you are missing `ENV` variables on bootup, `_env_checker.rb` will let you know. If you add or remove `ENV` vars to the project, you must also modify this file before they can be merged. The wiki above should handle all the necessary keys for basic development. #### Starting the application We're mostly a Rails app, with a bit of Webpack sprinkled in. **For most cases, simply running `bin/rails server` will do.** If you're working with Webpack though, you'll need to run the following: @@ -182,8 +182,8 @@ Name the branch in the following manner. ###### Examples ``` ben/feature/renderer-cookies -niko/hotfix/dockerfile-base-image -andy-and-niko/issue/#132-broken-link +jess/hotfix/dockerfile-base-image +andy-mac/issue/#132-broken-link ``` #### Pull request guideline