Built on a modified version of my react-fullstack-starter boilerplate. Additional commits added within a two hour limit.
Visit the app at journal-code-challenge.herokuapp.com, or set up development environment below.
I think the biggest risk in this process was moving the app from development to production environments. While I fortunately started early with the boilerplate, there were several pieces of legacy code that I had forgotten to strip that caused problems when deploying into the production environment.
If I'm planning on building a strong foundation on top of an old codebase, make sure it is sufficiently tested and there are safeguards to detect and diagnose production failures.
Clean my boilerplate properly! More broadly, I think there's a related lesson about not being afraid to delete old code (it's saved in git!) rather than commenting it out in case you might need it later. It reduces complexity of your code and reduces the likelihood of unintended side effects.
- Initial Machine Setup. First time running the starter kit? Then complete the Initial Machine Setup.
- Clone the project.
git clone https://github.com/rvillanueva/journal-code-challenge.git
. - Install dependencies.
yarn install
- Setup redis and postgres Make sure you're running redis and postgres on your local machine.
- Run the example app.
yarn run dev
This will run the automated build process, start up a webserver, and open the application in your default browser. When doing development with this kit, this command will continue watching all your files. Every time you hit save the code is rebuilt, linting runs, and tests run automatically. Note: The -s flag is optional. It enables silent mode which suppresses unnecessary messages during the build. - Having issues? See "Having Issues?" below.
- Install Node 4.0.0 or greater - (5.0 or greater is recommended for optimal build performance). Need to run multiple versions of Node? Use nvm.
- Install Git.
- Install Watchman.
- Install Postgres. Make sure it's running in the background.
- Disable safe write in your editor to assure hot reloading works properly.
- On a Mac? You're all set. If you're on Linux or Windows, complete the steps for your OS below.
On Linux:
- Run this to increase the limit on the number of files Linux will watch. Here's why.
echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
On Windows:
- Install Python 2.7. Some node modules may rely on node-gyp, which requires Python on Windows.
- Install C++ Compiler. Browser-sync requires a C++ compiler on Windows. Visual Studio Express comes bundled with a free C++ compiler. Or, if you already have Visual Studio installed: Open Visual Studio and go to File -> New -> Project -> Visual C++ -> Install Visual C++ Tools for Windows Desktop. The C++ compiler is used to compile browser-sync (and perhaps other Node modules).
-
Make sure you ran all steps in get started including the initial machine startup.
-
Run
yarn install
- If you forget to do this, you'll see this:babel-node: command not found
. -
Install the latest version of Node. Or install Node 5.12.0 if you're having issues on Windows. Node 6 has issues on some Windows machines.
-
Make sure files with names that begin with a dot (.babelrc, .editorconfig, .eslintrc) are copied to the project directory root. This is easy to overlook if you copy this repository manually.
-
Don't run the project from a symbolic link. It may cause issues with file watches.
-
Delete any .eslintrc that you're storing in your user directory. Also, disable any ESLint plugin / custom rules that you've enabled within your editor. These will conflict with the ESLint rules defined in this project.
-
Make sure you don't have NODE_ENV set to production on your machine. If you do then the development dependencies won't be installed. Here's how to check.
-
Tip: Things to check if you get an
npm run lint
error or build error:-
If ESW found an error or warning in your project (e.g. console statement or a missing semi-colon), the lint thread will exit with
Exit status 1
. To fix:- Change the
npm run lint
script to"esw webpack.config.* src tools; exit 0"
- Change the
npm run lint:watch
script to"esw webpack.config.* src tools --watch; exit 0"
Note: Adding
exit 0
will allow the npm scripts to ignore the status 1 and allow ESW to print all warnings and errors. - Change the
-
Ensure the
eslint
/esw
globally installed version matches the version used in the project. This will ensure theesw
keyword is resolved.
-
The starter kit includes a working example app that puts all of the above to use.
Check out the FAQ