Skip to content

Latest commit

 

History

History
123 lines (65 loc) · 4.89 KB

README.md

File metadata and controls

123 lines (65 loc) · 4.89 KB

This project is a combination of a bootstrapped Create React App and various tools and configurations that will hopefully allow for production development straight away.

ESlint

Included is eslint, together with the Airbnb linting rules slightly modified.

MaterialUI

MaterialUI from google is provided as a bases for out of the box react components.

React-Redux

React-Redux is included as an application state management system.

Jest

Jest is provided and setup as a mocking, test runner and assertion library. Various Jest plugins have also been provided to make your linting experience smoother. Jest

Enzyme

In conjunction with Jest Enzyme is included as a tool to allow you to unit test you’re components in a virtual dom, see Enzyme.

React-Router

react-router is also included for routing.

React-Intl

From yahoo react-intl is provided for localization see react-intl

Redux DevTools

The project is also setup out of the box to use the Redux DevTools, this will allow you to view the applications state as the user interacts with the application. see redux devtools

The application has examples throughout on using the various libraries mentioned.

Handy VSCode Extensions

Debugger for Chrome

The application is already be setup to allow you to set breakpoints within the application see vscode-debugger

ESLint

If linting doesn't work right away install this extension vscode-eslint

VSCode Icons

Very nice Icons for VSCode icons

ES7 React/Redux snippets

Allows you to use snippets within the editor (less typing :) ) vscode-snippets

see below for further information on how to debug and test the application.

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify