Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 2.52 KB

README.md

File metadata and controls

61 lines (40 loc) · 2.52 KB

GitHub license GitHub license npm version npm version

Synergy is a framework for building modular, configurable and scalable UI components for React-DOM projects

Boilerplate Features
  • Includes React, ReactDOM and the Synergy framework
  • Includes Babel transpilation
  • Easy dev environment with webpack-dev-server and hot-reloading

View this boilerplate on CodeSandbox

Setup

  1. Clone the repository and then navigate into the cloned directory
git clone https://github.com/One-Nexus/Synergy-Boilerplate.git && cd Synergy-Boilerplate
  1. Install dependencies
npm install
  1. Start the development server
npm start
  1. ...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.

Sample Modules

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.

Sample Theme

This boilerplate comes with a theme preloaded where you can find custom theme-level styles for MyModule.