momentum-design / starter-react

ReactJS starter application for the Collaboration Design System based on react slingshot and using Collab UI React

Momentum UI React Starter

A comprehensive starter kit for rapid application development using Momentum UI React.

Why Momentum UI React Starter?

1. One command to get started - Type yarn start to start development in your default browser.
2. Rapid feedback - Each time you hit save, changes hot reload and linting and automated tests run.
3. One command line to check - All feedback is displayed on a single command line.
4. No more JavaScript fatigue - Starter React uses the most popular and powerful libraries for working with React.
5. Working example app - The included example app shows how this all works together.
6. Automated production build - Type yarn run build to do all this:

Get Started

1. Initial Machine Setup

   First time running the starter kit? Then complete the Initial Machine Setup.

2. Clone the project

   git clone https://github.com/momentum-design/starter-react.git.

3. Run the setup script

   yarn install

4. Run the example app

   yarn start -s

   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.

5. Review the example app.

   This starter kit includes a working example app. Note how all source code is placed under /src. Tests are placed alongside the file under test. The final built app is placed under /dist. These are the files you run in production.

6. Having issues? See Having Issues?.

Initial Machine Setup

1. Install Node 6.0.0 or greater

   (6.0 or greater is recommended for optimal build performance) Need to run multiple versions of Node? Use nvm.

2. Install Git.

3. Disable safe write in your editor to assure hot reloading works properly.

4. 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.

     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.

     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).

---

Having Issues? Try these things first

1. Make sure you ran all steps in Get started including the initial machine setup.

2. Run yarn install - If you forget to do this, you'll see this: babel-node: command not found.

3. 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.

4. Make sure files with names that begin with a dot (.editorconfig, .gitignore, .npmrc) are copied to the project directory root. This is easy to overlook if you copy this repository manually.

5. Don't run the project from a symbolic link. It may cause issues with file watches.

6. 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.

7. 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.

8. Install watchman with brew install watchman if you are having the following error after an initial yarn start -s:

   2017-09-05 00:44 node[68587] (FSEvents.framework) FSEventStreamStart: register_with_server: ERROR: f2d_register_rpc() => (null) (-22)
   2017-09-05 00:44 node[68587] (FSEvents.framework) FSEventStreamStart: register_with_server: ERROR: f2d_register_rpc() => (null) (-22)
   events.js:160
         throw er; // Unhandled 'error' event
         ^
   
   Error: Error watching file for changes: EMFILE
       at exports._errnoException (util.js:1022:11)
       at FSEvent.FSWatcher._handle.onchange (fs.js:1406:11)

9. Tip: Things to check if you get an yarn 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:

     1. Change the yarn run lint script to "esw webpack.config.* src tools; exit 0"
     2. Change the yarn 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.

   • Ensure the eslint/esw globally installed version matches the version used in the project. This will ensure the esw keyword is resolved.

10. Rebuild node-sass with yarn rebuild node-sass if you are having and error like Node Sass does not yet support your current environment on macOS XXX after an initial yarn start -s.

---

Technologies

Momentum UI React Starter offers a rich development experience using the following technologies:

Tech	Description	Learn More
React	Fast, composable client-side components.	Pluralsight Course
Redux	Enforces unidirectional data flows and immutable, hot reloadable store. Supports time-travel debugging. Lean alternative to Facebook's Flux.	Getting Started with Redux, Building React Applications with Idiomatic Redux, Pluralsight Course
React Router	A complete routing library for React	Pluralsight Course
Babel	Compiles ES6 to ES5. Enjoy the new version of JavaScript today.	ES6 REPL, ES6 vs ES5, ES6 Katas, Pluralsight course
Webpack	Bundles npm packages and our JS into a single file. Includes hot reloading via react-transform-hmr.	Quick Webpack How-to Pluralsight Course
Browsersync	Lightweight development HTTP server that supports synchronized testing and debugging on multiple devices.	Intro vid
Jest	Automated tests with built-in expect assertions and Enzyme for DOM testing without a browser using Node.	Pluralsight Course
TrackJS	JavaScript error tracking.	Free trial
ESLint	Lint JS. Reports syntax and style issues. Using eslint-plugin-react for additional React specific linting rules.
SASS	Compiled CSS styles with variables, functions, and more.	Pluralsight Course
PostCSS	Transform styles with JS plugins. Used to autoprefix CSS
Editor Config	Enforce consistent editor settings (spaces vs tabs, etc).	IDE Plugins
npm Scripts	Glues all this together in a handy automated build.	Pluralsight course, Why not Gulp?

The starter kit includes a working example app that puts all of the above to use.

---

Questions?

Check out the FAQ