maverick/docbrown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README updates for clarification (#4584)

Browse source 
* Update README to clarify Algolia setup

Added a little bit to the line about Algolia environment variable setup
to clarify things for users like me who don't read ahead a little bit
and forgot how env variables work :)

* Add ImageMagick to prerequisites section
This commit is contained in:
James Vanderburg 2019-10-26 12:28:54 -05:00 • committed by Ben Halpern
parent e226a8e70d
commit 2d373c2de3
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -72,6 +72,7 @@ This section provides a high-level requirement & quick start guide. **For detail
- [Ruby](https://www.ruby-lang.org/en/): we recommend using [rbenv](https://github.com/rbenv/rbenv) to install the Ruby version listed on the badge.
- [Yarn](https://yarnpkg.com/): please refer to their [installation guide](https://yarnpkg.com/en/docs/install).
- [PostgreSQL](https://www.postgresql.org/) 9.4 or higher.
- [ImageMagick](https://imagemagick.org/): please refer to ImageMagick's [installation instructions](https://imagemagick.org/script/download.php). Alternatively, macOS users can install ImageMagick with `brew install imagemagick`.
### Standard Installation
@ -80,7 +81,7 @@ This section provides a high-level requirement & quick start guide. **For detail
1. Clone your forked repository, ie. `git clone https://github.com/<your-username>/dev.to.git`
1. Set up your environment variables/secrets
- Take a look at `Envfile`. This file lists all the `ENV` variables we use and provides a fake default for any missing keys. You'll need to get your own free [Algolia credentials](https://docs.dev.to/backend/algolia/) to get your development environment running.
- Take a look at `Envfile`. This file lists all the `ENV` variables we use and provides a fake default for any missing keys. You'll need to get your own free [Algolia credentials](https://docs.dev.to/backend/algolia/) to get your development environment running. You can add these to your `config/application.yml` file using the process described below.
- This [guide](https://docs.dev.to/backend/) will show you how to get free API keys for additional services that may be required to run certain parts of the app.
- For any key that you wish to enter/replace:
1. Create `config/application.yml` by copying from the provided template (ie. with bash: `cp config/sample_application.yml config/application.yml`). This is a personal file that is ignored in git.