diff --git a/README.md b/README.md index 54a1855..36ffc36 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,20 @@ To use this boilerplate, you'll need to take the following steps: * To use OAuth with Google, complete the step above with a real client ID and client secret from Google * You can get them here: https://console.developers.google.com/apis/credentials +* Finally, complete the section below to set up your linter + +## Linting + +Linters are a fundamental tool to any project - it ensures that code your working with has a consistent style, which is critical to writing readable code. + +Everyone has their own style, so Boilermaker does not come prepackaged with a linter. However, we `strongly` recommend that you (and your team, if working in a group) decide on a style, and stick with it. Here's what you need to do: + +* `npm install -g eslint` +* In the root of your project, `eslint --init` +* You will then be prompted to choose how you want to configure ESLint. We recommend selecting the `Use a popular style guide option`. The existing Boilermaker code was written in accordance with the `Standard` style, but you may choose a different one if you don't like it. + * [Standard style guide](https://standardjs.com/) + * [Airbnb style guide](https://github.com/airbnb/javascript) + * [Google style guide](https://google.github.io/styleguide/jsguide.html) ## Start diff --git a/client/history.js b/client/history.js index 8018628..6e1e1b6 100644 --- a/client/history.js +++ b/client/history.js @@ -3,5 +3,5 @@ import createMemoryHistory from 'history/createMemoryHistory' const history = process.env.NODE_ENV === 'test' ? createMemoryHistory() : createHistory() -export default history; +export default history