Skip to content

Latest commit

 

History

History
91 lines (56 loc) · 4.52 KB

README.md

File metadata and controls

91 lines (56 loc) · 4.52 KB

Electrode Logo
Electrode

Gitter Build Status devDependencies Status

A Platform for building Universal React/Node.js applications

Built at @WalmartLabs powering the walmart.com eCommerce site, Electrode is a platform for building universal React/Node.js 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.

Read the Announcement Blog Post.

Getting Started

Report a bug or request a feature

https://github.com/electrode-io/electrode/issues

Report an issue or help out with the docs

https://github.com/electrode-io/electrode-io.github.io/issues

Packages

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

App Archetype

electrode-archetype-react-app is a NPM module 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.

Yeoman Generator

The Yeoman generator-electrode NPM module allows you to quickly create an Universal React App with support from the app archetype, and server in Node with Hapi or Express.

Sample Applications

Some sample applications can be found under the samples directory.

Docs

Electrode platform creates and hosts books under docs directory. It contains the full documentation of electrode, generated using GitBook.

See Gitbook Toolchain for more details.

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 following Electrode modules:

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.

Built with ❤️ by Team Electrode @WalmartLabs.