MadeClear is a React Router Redux application created to allow software developers to generate clear privacy policies snapshots for their users.
This application leverages the React Redux Starter Kit. Because of this integration all of the documentation found at that repository is applicable including the methods to run webpack dev server, lint, test, and deploy. Most of that documentation is included below as well.
Those interested in forking this repository to continue development should study the structure outlined below.
Differences from React Redux Starter Kit
This application assumes the usage of npm. Do not use yarn unless you first add all of the additional packages to the yarn config file.
After confirming that your development environment meets the specified requirements, you can create a new project by doing the following:
Install from source
First, clone the project:
$ git clone https://github.com/ajveach/MadeClear.git <my-project-name> $ cd <my-project-name>
Then install dependencies and check to see it works. It is required that you use npm for this step.
$ npm install # Install project dependencies $ npm start # Compile and launch
If everything works, you should see the following:
While developing, you will probably rely mostly on
npm start; however, there are additional scripts at your disposal:
||Serves your app at
||Compiles the application to disk (
||Runs unit tests with Karma and generates a coverage report.|
||Runs Karma and watches for changes to re-run tests; does not generate coverage reports.|
||Runs linter, tests, and then, on success, compiles your application to disk.|
||Lint and fix all
The application structure presented in this boilerplate is fractal, where functionality is grouped primarily by feature rather than file type. Please note, however, that this structure is only meant to serve as a guide, it is by no means prescriptive. That said, it aims to represent generally accepted guidelines and patterns for building scalable applications. If you wish to read more about this pattern, please check out this awesome writeup by Justin Greenberg.
. ├── bin # Build/Start scripts ├── config # Project and build configurations ├── public # Static public assets (not imported anywhere in source code) ├── server # Express application that provides webpack middleware │ └── main.js # Server application entry point ├── src # Application source code │ ├── index.html # Main HTML page container for app │ ├── main.js # Application bootstrap and rendering │ ├── components # Global Reusable Presentational Components │ ├── containers # Global Reusable Container Components │ ├── layouts # Components that dictate major page structure │ │ └── CoreLayout.js # CoreLayout which receives children for each route │ │ └── CoreLayout.scss # Styles related to the CoreLayout │ │ └── index.js # Main file for layout │ ├── routes # Main route definitions and async split points │ │ ├── index.js # Bootstrap main application routes with store │ │ ├── Home # Fractal route │ │ │ ├── index.js # Route definitions and async split points │ │ │ ├── assets # Assets required to render components │ │ │ ├── components # Presentational React Components │ │ │ └── routes ** # Fractal sub-routes (** optional) │ │ └── Counter # Fractal route │ │ ├── index.js # Counter route definition │ │ ├── container # Connect components to actions and store │ │ ├── modules # Collections of reducers/constants/actions │ │ └── routes ** # Fractal sub-routes (** optional) │ ├── store # Redux-specific pieces │ │ ├── createStore.js # Create and instrument redux store │ │ └── reducers.js # Reducer registry and injection │ └── styles # Application-wide styles (generally settings) └── tests # Unit tests
We recommend using the Redux DevTools Chrome Extension. Using the chrome extension allows your monitors to run on a separate thread and affords better performance and functionality. It comes with several of the most popular monitors, is easy to configure, filters actions, and doesn’t require installing any packages.
However, adding the DevTools components to your project is simple. First, grab the packages from npm:
npm i --save-dev redux-devtools redux-devtools-log-monitor redux-devtools-dock-monitor
Then follow the manual integration walkthrough.
To add a unit test, simply create a
.spec.js file anywhere in
~/tests. Karma will pick up on these files automatically, and Mocha and Chai will be available within your test without the need to import them. Coverage reports will be compiled to
~/coverage by default. If you wish to change what reporters are used and where reports are compiled, you can do so by modifying
Out of the box, this starter kit is deployable by serving the
~/dist folder generated by
npm run deploy (make sure to specify your target
NODE_ENV as well). This project does not concern itself with the details of server-side rendering or API structure, since that demands an opinionated structure that makes it difficult to extend the starter kit. However, if you do need help with more advanced deployment strategies, here are a few tips:
If you are serving the application via a web server such as nginx, make sure to direct incoming routes to the root
~/dist/index.html file and let react-router take care of the rest. If you are unsure of how to do this, you might find this documentation helpful. The Express server that comes with the starter kit is able to be extended to serve as an API or whatever else you need, but that's entirely up to you.
Default project configuration can be found in
~/config/project.config.js. Here you'll be able to redefine your
dist directories, adjust compilation settings, tweak your vendor dependencies, and more. For the most part, you should be able to make changes in here without ever having to touch the actual webpack build configuration.
If you need environment-specific overrides (useful for dynamically setting API endpoints, for example), you can edit
~/config/environments.config.js and define overrides on a per-NODE_ENV basis. There are examples for both
production, so use those as guidelines. Here are some common configuration options:
||application source code base path|
||path to build compiled application to|
||hostname for the Express server|
||port for the Express server|
||what type of source-maps to generate (set to
||packages to separate into to the vendor bundle|
Webpack is configured to make use of resolve.root, which lets you import local packages as if you were traversing from the root of your
~/src directory. Here's an example:
// current file: ~/src/views/some/nested/View.js // What used to be this: import SomeComponent from '../../../components/SomeComponent' // Can now be this: import SomeComponent from 'components/SomeComponent' // Hooray!
These are global variables available to you anywhere in your source code. If you wish to modify them, they can be found as the
globals key in
~/config/project.config.js. When adding new globals, make sure you also add them to
.css file extensions are supported out of the box. After being imported, styles will be processed with PostCSS for minification and autoprefixing, and will be extracted to a
.css file during production builds.
This starter kit comes packaged with an Express server. It's important to note that the sole purpose of this server is to provide
webpack-hot-middleware for hot module replacement. Using a custom Express app in place of webpack-dev-server makes it easier to extend the starter kit to include functionality such as API's, universal rendering, and more -- all without bloating the base boilerplate.
Babel is configured to use babel-plugin-transform-runtime so transforms aren't inlined. In production, webpack will extract styles to a
- Starting out with react-redux-starter-kit is an introduction to the components used in this starter kit with a small example in the end.
Having trouble? Check out the FAQ or submit an issue. Please be considerate by only posting issues that are directly related to this project; questions about how to implement certain React or Redux features are both best suited for StackOverflow or their respective repositories.