Synergy is a framework for building modular, configurable and scalable UI components for React-DOM projects
- Includes React, ReactDOM and the Synergy framework
- Includes Babel transpilation
- Easy dev environment with webpack-dev-server and hot-reloading
- Clone the repository and then navigate into the cloned directory
git clone https://github.com/One-Nexus/Synergy-Boilerplate.git && cd Synergy-Boilerplate
- Install dependencies
npm install
- Start the development server
npm start
- ...happy coding!
Access the devlopment server in the browser (default port is 8080, so visit http://localhost:8080). Start looking through the sample module and theme code - make some changes and see them reflected in your browser instantly!
To bundle your application, run npm run build
. The application bundle will be created at ./dist/app.js
.
This boilerplate provides 2 sample modules to get started with, MyModule
which is split into multiple files, and Accordion
, which exists as a single file. This is so you can get a feel for the two most ssignificant ways to construct modules so you can decide which you prefer.
This boilerplate comes with a theme preloaded where you can find custom theme-level styles for MyModule
.