electrode
Electrode

Updated 5 hours 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 baked 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 provides for common patterns across all app projects so that each app project can standardize on common development behavior and patterns. Its essentially pre-made patterns 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 an Universal React App or Component with support from the archetypes, and server in Node with Hapi or Express.

You can learn how to use them here.

Sample Applications

Some sample applications can be found under the samples directory.

Other Standalone Modules

In addition to the archetypes and the generators, Electrode platform also comes with a fleet of battle tested enterprise grade modules that're designed to make up a solution for developing and deploying NodeJS applications to power sites like http://www.walmart.com:

Boilerplate Universal React Node

Under samples/universal-react-node is a sample Electrode app that was created with the Electrode generator and consumes the Electrode App archetype modules. We've added other demos and features to it to serve as examples. It demonstrates usage with the standalone NodeJS modules listed above.

See its README for more details.

Sample Universal React Node with material-ui

Under samples/universal-material-ui is a sample Electrode app that uses the material-ui React components.

See its README for more details.

More Samples

We have more separate Electrode Sample Apps at https://github.com/electrode-samples that you can use as references.

Support and Acknowledgement

We'd like to thank our employer @WalmartLabs because we can work on the development of Electrode platform and associated modules as Open Sourced Software for the needs of our internal teams and projects. We love the public community and the support we get, and we address your requests as much as we could, even on our off hours. We are always excited to get feedbacks, bug reports, and PRs. Even if you just show us your support and encouragements, or help us promote Electrode, and we love to make Electrode work better for everyone. Thank you.

License

Copyright 2016 WalmartLabs

Licensed under the Apache License, Version 2.0.