Skip to content

Commit

Permalink
[major] re-organize exports and ES modules
Browse files Browse the repository at this point in the history
  • Loading branch information
jchip committed Jan 29, 2021
1 parent e945a27 commit f886098
Show file tree
Hide file tree
Showing 218 changed files with 1,516 additions and 2,720 deletions.
33 changes: 9 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,40 +4,25 @@
<b>Electrode</b>
</p>

# Building large scale universal React Web Applications
# Web Applications with node.js and React

Electrode Web is a full stack, end-to-end, rapid application development platform for Node.js and React.js based applications.
Electrode was developed to make node.js and React.js a primary tech choice for developing applications at Walmart. It has been powering the <http://www.walmart.com> eCommerce website since 2017.

Originally designed for Walmart-specific use cases, we decided to open-source electrode with the hope that it will be useful to developers in the JavaScript community.
This is the same version that is used to power the Walmart.com eCommerce website.

- NOTE: We maintain additional code for internal Walmart systems. If you are a Walmart developer, please check internal docs to get started.

**Do you have 5 minutes?** That is how long it takes to scaffold your first app. Try it now!
Electrode Web is a rapid application development framework; a full stack, end-to-end platform for developing, deploying, and maintaining JavaScript applications at Walmart.

## electrode quick start

> You will need [Node.js] installed on your system
1. Run the following command in your console/terminal:
Originally designed for Walmart-specific use cases, we decided to open-source electrode with the hope that it will be useful to developers in the JavaScript community.

```bash
npm init @xarc/app my-app
```
This is the same version that is used to power many web applications at Walmart.

2. Wait a moment for the installer to complete the build.
3. When complete, the console will display `Created react/node webapp in directory 'my-app'`
4. Follow the instructions in the console.
5. When complete, open your browser to [localhost:3000](http://localhost:3000)
6. To stop the DEV server, press `Q`
# Getting Started

Your electrode app will appear as shown below.
Please go to our [docs](https://www.electrode.io/electrode/docs/getting-started) for further information and instructions on using Electrode.

![Hello from Electrode](docs/img/electrode-first-run.png)
> NOTE: We maintain additional code for internal Walmart systems. If you are a Walmart developer, please check internal docs to get started.
# Contributing

Do you find Electrode useful? Please send us your encouragement with a github star.
Do you find Electrode useful for your application development, or learning node.js or React? Please send us your encouragement with a github star.

Did you find an issue? Would you like to help with the project? Please see our [contributing guide] for instructions on [submitting a PR] or [reporting an issue].

Expand Down
16 changes: 0 additions & 16 deletions docusaurus/docs/community.md

This file was deleted.

40 changes: 21 additions & 19 deletions docusaurus/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ id: getting-started
title: Getting started
---

## Building large scale universal React Web Applications
## Web Applications with node.js and React

Electrode was developed as the engine that has been powering the <http://www.walmart.com> eCommerce website since 2016.
Electrode was developed to make node.js and React.js a primary tech choice for developing applications at Walmart. It has been powering the <http://www.walmart.com> eCommerce website since 2017.

Electrode Web is a rapid application development framework; a full stack, end-to-end platform for developing, deploying, and maintaining JavaScript applications at Walmart.

Expand All @@ -21,7 +21,7 @@ Try it now!

To generate and deploy your Electrode app and Electrode components, install the following (if you have not already):

1. Install the [node.js] version 10.x.x or later
1. Install the [node.js] version 12.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.
Expand Down Expand Up @@ -56,25 +56,27 @@ New Electrode X packages are published under the npm scope `@xarc`, where arc is

### 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 |
| Package | Description |
| ------------- | -------------------------------------------------------- |
| @xarc/app | node.js runtime support; should be in `dependencies` |
| @xarc/app-dev | development only support; should be in `devDependencies` |
| @xarc/react | react.js support |

#### 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 |
| Package | Description |
| ------------------ | ------------------------------------- |
| @xarc/react-redux | react redux support |
| @xarc/react-query | react query support |
| @xarc/react-router | react router support |
| @xarc/create-app | create a starter app for you with npx |
| @xarc/opt-postcss | Extra style support |
| @xarc/opt-stylus | stylus support |
| @xarc/opt-sass | sass support |
| @xarc/opt-less | less support |
| @xarc/opt-jest | jest support |
| @xarc/opt-karma | karma support |
| @xarc/opt-mocha | mocha support |

## License

Expand Down
54 changes: 0 additions & 54 deletions docusaurus/docs/glossary.md

This file was deleted.

Binary file removed docusaurus/docs/images/component-dev-started.png
Binary file not shown.
Binary file removed docusaurus/docs/images/edit-me.png
Binary file not shown.
Binary file removed docusaurus/docs/images/edit-me2.png
Binary file not shown.
Binary file removed docusaurus/docs/images/further-develop-app.png
Binary file not shown.
Binary file not shown.
Binary file removed docusaurus/docs/images/generator-component-add.png
Binary file not shown.
Binary file removed docusaurus/docs/images/ignite-help.png
Binary file not shown.
Binary file removed docusaurus/docs/images/ignite-menu.png
Binary file not shown.
61 changes: 0 additions & 61 deletions docusaurus/docs/welcome-to-electrode.md

This file was deleted.

3 changes: 1 addition & 2 deletions docusaurus/sidebars.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
module.exports = {
someSidebar: {
Introduction: ["welcome-to-electrode", "community", "glossary"],
Quick_Start: ["getting-started"]
"Quick Start": ["getting-started"]
}
};
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"devDependencies": {
"@xarc/run": "^1.0.4",
"bluebird": "^3.5.0",
"fynpo": "^0.1.32",
"fynpo": "^0.1.33",
"lerna": "^3.22.1",
"lodash": "^4.17.10",
"semver": "^5.3.0",
Expand Down
56 changes: 27 additions & 29 deletions packages/xarc-app-dev/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"compile": "tsc",
"build": "xrun -s compile user/moveDist",
"test": "xrun xarc/test-only",
"coverage": "xrun xarc/check",
"coverage": "xrun xarc/test-cov",
"format": "prettier --write --print-width 100 *.{js,jsx} `find . -type d -d 1 -exec echo '{}/**/*.{js,jsx}' \\; | egrep -v '(/node_modules/|/dist/|/coverage/)'`",
"prepublishOnly": "xrun [[build, docs], xarc/check]",
"docs": "xrun xarc/docs",
Expand All @@ -26,9 +26,9 @@
"config",
"dist",
"lib",
"src",
"require.js",
"scripts"
"scripts",
"src"
],
"author": "Electrode (http://www.electrode.io/)",
"contributors": [
Expand All @@ -51,11 +51,10 @@
"@babel/preset-typescript": "^7.0.0",
"@babel/register": "^7.0.0",
"@jchip/redbird": "^1.2.2",
"@loadable/babel-plugin": "^5.10.0",
"@xarc/run": "^1.0.4",
"@xarc/subapp": "^0.1.4",
"@xarc/webpack": "^9.1.1",
"ansi-to-html": "^0.6.8",
"babel-plugin-dynamic-import-node": "^2.2.0",
"babel-plugin-lodash": "^3.3.4",
"babel-plugin-minify-dead-code-elimination": "^0.5.0",
"babel-plugin-react-css-modules": "^5.2.6",
Expand All @@ -65,7 +64,6 @@
"chalker": "^1.2.0",
"chokidar": "^3.4.1",
"core-js": "^3.6.5",
"electrode-hapi-compat": "^1.3.3",
"electrode-node-resolver": "^2.0.2",
"fast-async": "^7.0.5",
"filter-scan-dir": "^1.0.10",
Expand Down Expand Up @@ -95,42 +93,42 @@
"webpack-dev-middleware": "^3.7.2",
"webpack-hot-middleware": "^2.25.0",
"winston": "^2.4.4",
"xaa": "^1.6.0",
"xaa": "^1.6.2",
"xenv-config": "^1.3.1",
"xsh": "^0.4.5"
},
"devDependencies": {
"@istanbuljs/nyc-config-typescript": "^1.0.1",
"@types/chai": "^4.2.11",
"@types/mocha": "^7.0.2",
"@types/node": "^13.7.6",
"@types/sinon": "^9.0.0",
"@types/sinon-chai": "^3.2.4",
"@typescript-eslint/eslint-plugin": "^2.21.0",
"@typescript-eslint/parser": "^2.21.0",
"@xarc/app": "^8.2.4",
"@xarc/module-dev": "^2.2.3",
"@types/chai": "^4.2.14",
"@types/mocha": "^8.2.0",
"@types/node": "^14.14.16",
"@types/sinon": "^9.0.10",
"@types/sinon-chai": "^3.2.5",
"@typescript-eslint/eslint-plugin": "^4.11.0",
"@typescript-eslint/parser": "^4.11.0",
"@xarc/app": "../xarc-app",
"@xarc/module-dev": "^3.0.2",
"@xarc/run": "^1.0.4",
"babel-eslint": "^10.1.0",
"chai": "^4.2.0",
"e1": "./e1",
"electrode-server": "^3.2.0",
"eslint": "^6.8.0",
"eslint": "^7.16.0",
"eslint-config-walmart": "^2.2.1",
"eslint-plugin-filenames": "^1.1.0",
"eslint-plugin-jsdoc": "^21.0.0",
"mocha": "^7.1.0",
"eslint-plugin-jsdoc": "^30.7.9",
"mocha": "^8.2.1",
"mock-require": "^3.0.3",
"nyc": "^15.0.0",
"nyc": "^15.1.0",
"prettier": "^1.14.2",
"run-verify": "^1.2.5",
"shx": "^0.3.2",
"sinon": "^7.2.6",
"sinon-chai": "^3.3.0",
"source-map-support": "^0.5.16",
"ts-node": "^8.6.2",
"typedoc": "^0.17.4",
"typescript": "^3.8.3"
"sinon": "^9.2.2",
"sinon-chai": "^3.5.0",
"source-map-support": "^0.5.19",
"ts-node": "^9.1.1",
"typedoc": "^0.20.13",
"typescript": "^4.1.3"
},
"engines": {
"node": ">= 12",
Expand Down Expand Up @@ -158,15 +156,15 @@
"exclude": [
"*clap.js",
"*clap.ts",
"config",
"coverage",
"dist",
"docs",
"gulpfile.js",
"lib",
"test",
"xrun*.js",
"xrun*.ts",
"lib",
"config"
"xrun*.ts"
],
"check-coverage": false,
"statements": 0,
Expand Down
Loading

0 comments on commit f886098

Please sign in to comment.