React Modem ·

Dynamic DRY routing for modular React interfaces.

• Intuitive and Liberal: Simplifies applications with internal modules and generalized layouts such as dashboards or toolboxes. Build modularized interfaces without having to manage every route directly, preserving the traditional usage of React Router (use as needed)!

• Auto Routing: Module names map to application URI endpoints automatically. Encouraging thoughtful project hierarchy and meaningful naming patterns.

• DRY Module Based Interfacing: Plug and unplug react components as modules, simplifying project structure to quickly build applications with high scalablity.

Getting Started

Dependencies

Install React and React Router DOM

npm install react react-router-dom

Installing and Importing

Install React Modem from npm

npm install react-modem

Utilize the React Modem API in ES6/7

import ReactModem from 'react-modem'
// or
import { connect, modularize } from 'react-modem'

Running Example Projects

To test ReactModem clone this repo and install with npm install. Run an example project with the following npm script

npm run example <Example>

where <Example> is the project folder you would like to run. Check examples/ for a list of test projects available.

e.g

npm run example Basic

Learn More

To learn more about how to use React Modem checkout API.md

Authors

• Lion Technology Solutions - Provides technology solutions that improve the way society learns, thinks and performs.
• Ezra Singh

License

This project is licensed under the MIT License - see the LICENSE.md file for details