Skip to content
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

fix(web): update website docs with @neo-one/suite #1436

Merged
merged 1 commit into from
Jun 5, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 5 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -270,15 +270,16 @@
},
"resolutions": {
"@reactivex/ix-es2015-cjs": "2.5.3",
"react-dom": "16.8.6",
"react": "16.8.6",
"ajv": "6.8.1",
"babel-core": "7.0.0-bridge.0",
"bn.js": "4.11.8",
"react": "16.8.6",
"react-dom": "16.8.6",
"resolve": "1.10.1",
"regenerator-runtime": "0.13.1",
"styled-components": "4.2.0",
"terser": "3.14.1",
"webpack": "4.32.2",
"styled-components": "4.2.0"
"webpack": "4.32.2"
},
"config": {
"commitizen": {
Expand Down
13 changes: 11 additions & 2 deletions packages/neo-one-website/tutorial/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,16 @@ Here's how to setup your local development environment:
- Windows: We recommend using [Chocolatey](https://chocolatey.org/).
2. Follow the [installation instructions for Create React App](https://reactjs.org/docs/create-a-new-react-app.html#create-react-app) to make a new project.
- Be sure to invoke Create React App with the `--typescript` flag in order to enable TypeScript support: `npx create-react-app token --typescript`
3. Install NEO•ONE using either [yarn](https://yarnpkg.com/) (`yarn add <package name>`) or [npm](https://www.npmjs.com/) (`npm install <package name>`).
3. Install NEO•ONE using either [yarn](https://yarnpkg.com/)
```bash
yarn add @neo-one/suite
````
or [npm](https://www.npmjs.com/)
```bash
npm install @neo-one/suite
```

alternatively, install the individual packages `@neo-one/suite` wraps for you:

```bash
yarn add @neo-one/cli @neo-one/client @neo-one/smart-contract @neo-one/smart-contract-test @neo-one/smart-contract-typescript-plugin
Expand All @@ -69,7 +78,7 @@ npm install @neo-one/cli @neo-one/client @neo-one/smart-contract @neo-one/smart-
We recommend taking a moment to [setup your editor](/docs/environment-setup#Editor-Setup) to take advantage of inline NEO•ONE compiler diagnostics.

5. Review the available [configuration options](/docs/config-options) and update your `.onerc` file as needed.
* To follow along with the tutorial you configuration should look something like:
* To follow along with the tutorial your configuration should look like:
```json
{
"codegen": {
Expand Down
13 changes: 1 addition & 12 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -15861,24 +15861,13 @@ resolve-url@^0.2.1:
version "0.2.1"
resolved "https://registry.yarnpkg.com/resolve-url/-/resolve-url-0.2.1.tgz#2c637fe77c893afd2a663fe21aa9080068e2052a"

resolve@1.1.7:
version "1.1.7"
resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.1.7.tgz#203114d82ad2c5ed9e8e0411b3932875e889e97b"

resolve@1.10.1:
resolve@1.1.7, resolve@1.10.1, resolve@1.x, resolve@^1.1.6, resolve@^1.1.7, resolve@^1.10.0, resolve@^1.3.2, resolve@^1.4.0, resolve@^1.8.1:
version "1.10.1"
resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.10.1.tgz#664842ac960795bbe758221cdccda61fb64b5f18"
integrity sha512-KuIe4mf++td/eFb6wkaPbMDnP6kObCaEtIDuHOUED6MNUo4K670KZUHuuvYPZDxNF0WVLw49n06M2m2dXphEzA==
dependencies:
path-parse "^1.0.6"

resolve@1.x, resolve@^1.1.6, resolve@^1.1.7, resolve@^1.10.0, resolve@^1.3.2, resolve@^1.4.0, resolve@^1.8.1:
version "1.11.0"
resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.11.0.tgz#4014870ba296176b86343d50b60f3b50609ce232"
integrity sha512-WL2pBDjqT6pGUNSUzMw00o4T7If+z4H2x3Gz893WoUQ5KW8Vr9txp00ykiP16VBaZF5+j/OcXJHZ9+PCvdiDKw==
dependencies:
path-parse "^1.0.6"

restore-cursor@^1.0.1:
version "1.0.1"
resolved "https://registry.yarnpkg.com/restore-cursor/-/restore-cursor-1.0.1.tgz#34661f46886327fed2991479152252df92daa541"
Expand Down