-
Notifications
You must be signed in to change notification settings - Fork 300
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
updated GitBook to Docusaurus #1673
Changes from 11 commits
19456e9
3a46231
7fe7799
2a043c6
466306d
1e067bf
ed3f507
c6057ad
5647390
60e9463
6c39e87
c500b4d
efc5c98
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,65 +4,40 @@ | |
<b>Electrode</b> | ||
</p> | ||
|
||
[![Gitter](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/electrode-io/electrode) | ||
[![Build Status][travis-image]][travis-url] [![devDependencies Status][daviddm-image]][daviddm-url] | ||
# Building large scale universal React Web Applications | ||
|
||
### Building large scale universal React Web Applications | ||
Electrode Web is a rapid application development framework; a full stack, end-to-end platform for developing, deploying, and maintaining JavaScript applications at Walmart, afor the <http://www.walmart.com> eCommerce website. | ||
|
||
> 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. | ||
We maintain additional code to support internal systems. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For Walmart applications, we maintain additional code to support proprietary internal systems. If you are a Walmart developer working on internal applications, please check internal docs to get started. |
||
> If you are a Walmart developer, please check internal docs to get started. | ||
|
||
**It takes 5 minutes and a single command to get your own Universal React app to customize:** | ||
**Do you have 5 minutes?** That is how long it takes to scaffold your first app. Try it now! | ||
|
||
![Hello from Electrode][hello-electrode] | ||
## electrode quick start | ||
|
||
# Getting Started | ||
> You will need [Node.js] installed on your system | ||
|
||
- See the [Full README.md in docs](docs/README.md) or visit our [gitbook documents]. | ||
1. Run the following command in your console/terminal: | ||
|
||
- [Getting Started with Electrode] | ||
```bash | ||
npm init @xarc/app my-app | ||
``` | ||
|
||
- Visit our site at <http://www.electrode.io>. | ||
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` | ||
|
||
- See [What is Electrode] for more details on features and technologies supported. | ||
Your electrode app will appear as shown below. | ||
|
||
# Documentation | ||
|
||
The documents for Electrode are maintained as [gitbook documents] in the [docs](/docs) directory. | ||
|
||
Check [gitbook] for more info about gitbook. | ||
|
||
# Contributing | ||
This conversation was marked as resolved.
Show resolved
Hide resolved
|
||
|
||
Do you find Electrode useful? 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]. | ||
|
||
# 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 encouragement, or help us promote Electrode, and we love to make Electrode work better for everyone. Thank you. | ||
![Hello from Electrode](docs/static/img/electrode-first-run.png) | ||
|
||
# License | ||
|
||
Copyright (c) 2016-present, WalmartLabs | ||
Copyright (c) 2016-present, Walmart | ||
|
||
Licensed under the [Apache License, Version 2.0]. | ||
Licensed under the [Apache License, Version 2.0] | ||
|
||
[apache license, version 2.0]: https://www.apache.org/licenses/LICENSE-2.0 | ||
[announcement blog]: https://medium.com/walmartlabs/introducing-electrode-an-open-source-release-from-walmartlabs-14b836135319#.pwbddxg1z | ||
[material-ui]: http://www.material-ui.com | ||
[lerna]: https://lernajs.io/ | ||
[electrode-archetype-react-app]: packages/electrode-archetype-react-app | ||
[electrode-archetype-react-app-dev]: packages/electrode-archetype-react-app-dev | ||
[generator-electrode]: packages/generator-electrode | ||
[travis-image]: https://travis-ci.org/electrode-io/electrode.svg?branch=master | ||
[travis-url]: https://travis-ci.org/electrode-io/electrode | ||
[daviddm-image]: https://david-dm.org/electrode-io/electrode/dev-status.svg | ||
[daviddm-url]: https://david-dm.org/electrode-io/electrode?type=dev | ||
[gitbook]: https://www.gitbook.com/ | ||
[gitbook documents]: https://docs.electrode.io/overview/what-is-electrode.html | ||
[what is electrode]: https://docs.electrode.io/overview/what-is-electrode.html | ||
[getting started with electrode]: https://docs.electrode.io/chapter1/quick-start/start-with-app.html | ||
[hello-electrode]: docs/images/hello-electrode.png | ||
[submitting a pr]: https://github.com/electrode-io/electrode/pulls | ||
[reporting an issue]: https://github.com/electrode-io/electrode/issues | ||
[contributing guide]: CONTRIBUTING.md | ||
[Node.js]: https://nodejs.org/en/download |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Dependencies | ||
/node_modules | ||
|
||
# Production | ||
/build | ||
|
||
# Generated files | ||
.docusaurus | ||
.cache-loader | ||
|
||
# Misc | ||
.DS_Store | ||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
|
||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* |
This file was deleted.
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
id: hola | ||
title: Hola | ||
author: Gao Wei | ||
author_title: Docusaurus Core Team | ||
author_url: https://github.com/wgao19 | ||
author_image_url: https://avatars1.githubusercontent.com/u/2055384?v=4 | ||
tags: [hola, docusaurus] | ||
--- | ||
|
||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
id: hello-world | ||
title: Hello | ||
author: Endilie Yacop Sucipto | ||
author_title: Maintainer of Docusaurus | ||
author_url: https://github.com/endiliey | ||
author_image_url: https://avatars1.githubusercontent.com/u/17883920?s=460&v=4 | ||
tags: [hello, docusaurus] | ||
--- | ||
|
||
Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://v2.docusaurus.io/). | ||
|
||
<!--truncate--> | ||
|
||
This is a test post. | ||
|
||
A whole bunch of other information. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
id: welcome | ||
title: Welcome | ||
author: Yangshun Tay | ||
author_title: Front End Engineer @ Facebook | ||
author_url: https://github.com/yangshun | ||
author_image_url: https://avatars0.githubusercontent.com/u/1315101?s=400&v=4 | ||
tags: [facebook, hello, docusaurus] | ||
--- | ||
|
||
Blog features are powered by the blog plugin. Simply add files to the `blog` directory. It supports tags as well! | ||
|
||
Delete the whole directory if you don't want the blog features. As simple as that! |
This file was deleted.
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
afor
?