electrode
Electrode

Updated 4 days ago


Electrode

Building large scale universal React Web Applications

Built at @WalmartLabs powering the http://www.walmart.com eCommerce site, Electrode is a platform for building small to large scale universal ReactJS/NodeJS web applications with a standardized structure, best practices, and modern technologies built in. Electrode focuses on performance, component reusability, and simple deployment to multiple cloud providers—so you can focus on what makes your app unique.

Getting Started

Contributing

See our contributing guide for instructions on submitting a PR or reporting an issue.

Packages

The Electrode main repo uses Lerna to manage multiple related packages that are part of the Electrode Core.

App Archetype

electrode-archetype-react-app is a pair of complementing npm modules that allows common patterns across all app projects so that each app project can standardize on common development behavior and patterns. Its essentially pattern templates for build scripts. It also requires a companion module electrode-archetype-react-app-dev that's meant for your app's devDependencies.

Component Archetype

electrode-archetype-react-component is a pair of complementing npm modules that makes developing reusable React components as easy as possible with all the latest tools and technologies configured for you.

Yeoman Generator

The Yeoman generator-electrode npm module allows you to quickly create a Universal React App or Component with support from the archetypes, and server in Node with Hapi or Express.

For information on how to use the modules, check out Get Started With Electrode App.

Sample Applications

You can find sample applications in the samples directory.

Other Standalone Modules

In addition to the archetypes and the generators, Electrode includes a fleet of battle-tested enterprise modules that are designed as a framework for developing and deploying NodeJS applications to power sites like http://www.walmart.com:

Boilerplate Universal React Node

The samples/universal-react-node directory includes a sample Electrode app. The app was created with the Electrode generator using the Electrode App archetype modules. We've also added other demos and features to it to serve as examples. This app demonstrates how you can use the standalone NodeJS modules listed above.

For more information, see the README file.

Sample Universal React Node with material-ui

You can find a sample Electrode app that uses the material-ui React components located here: samples/universal-material-ui.

For more information, see the README file.

Additional Samples

We included additional Electrode Sample Apps in the https://github.com/electrode-samples directory. You can use the sample apps as references.

Support and Acknowledgement

We would like to thank @WalmartLabs for the opportunity to develop the Electrode platform and associated modules as open source software. We know that Electrode provides an important advancement for our internal teams and projects as well as for the open source community.

We value the open source community and the support we receive and we are committed to addressing all requests as soon as possible—even on our off hours. We look forward to your feedback, bug reports, and PRs. Even if your feedback is simply a sign of your support and encouragement, or to help us promote Electrode.

We are committed to continuing our efforts to improve open source projects and most importantly, to continue improving Electrode so that it works better for everyone.

Thank you!

License

©️ 2018 WalmartLabs

Licensed under the Apache License, Version 2.0.