Getting started
Building large scale universal React Web Applications
Electrode was developed as the engine that has been powering the http://www.walmart.com eCommerce website since 2016.
Electrode Web is a rapid application development framework; a full stack, end-to-end platform for developing, deploying, and maintaining JavaScript applications at Walmart.
important
Do you have 5 minutes? That is how long it takes to scaffold your first app.
Try it now!
Quick start
Development on your local machine
To generate and deploy your Electrode app and Electrode components, install the following (if you have not already):
Install the node.js version 10.x.x or later
- We recommend a tool such as nvm for managing node.js installations.
- If you are on Windows, then universal nvm is recommended.
To build an app scaffold, run the following command in your console/terminal:
npx @xarc/create-app my-app
- Wait for this to complete. The console will display the following with some instructions:
Created react/node webapp in directory 'my-app'
- Follow the instructions outlined in the console.
- When complete, open your browser to localhost:3000
- To stop the DEV server, press
Q
Your new electrode app will appear as shown below.
Important: Existing electrode users
If you are an existing electrode user, please take note of the following sections
@xarc npm Scope
New Electrode X packages are published under the npm scope @xarc, where arc is inspired by <www.twi-global.com/technical-knowledge/faqs/what-is-arc-welding>
Essentials
| Package | Description | Corresponding old package |
|---|---|---|
| @xarc/app | JS server runtime support for electrode X | electrode-archetype-react-app |
| @xarc/app-dev | dev support for electrode X | electrode-archetype-react-app-dev |
| @xarc/webpack | default webpack configs | N/A |
Optionals
| Package |
|---|
| @xarc/config-jest |
| @xarc/config-karma |
| @xarc/config-mocha |
| @xarc/ui-config |
| @xarc/ui-logger |
| @xarc/dll |
| @xarc/dll-dev |
| @xarc/config-eslint |
| @xarc/create-app |
License
Copyright (c) 2016-present, Walmart
Licensed under the Apache License, Version 2.0