Skip to content

Update tutorials running locally page - #1042

Merged
lijiarui merged 2 commits into
wechaty:masterfrom
sbis04:doc-update-running-locally
Jul 30, 2021
Merged

lijiarui merged 2 commits into
wechaty:masterfrom
sbis04:doc-update-running-locally

Conversation

@sbis04

@sbis04 sbis04 commented Jul 10, 2021 •

Copy link
Copy Markdown
Contributor

The current Running locally page under Tutorials is missing an important command without which the NPM project won't be initialized and none of the dependencies can be installed.

Have added the npm init -y command before installing dependencies. (this was present in PR #888 earlier but I think after the last change before merging it got removed by mistake).

Before:

Screenshot 2021-07-10 at 8 10 17 AM

After

Screenshot 2021-07-10 at 8 09 39 AM

Tag #891

@sbis04 sbis04 added GSoD 2021 tutorials Related to tutorial docs labels Jul 10, 2021
@sbis04
sbis04 requested a review from a team as a code owner July 10, 2021 02:48
```bash
npm init -y
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section can probably be removed ? @proudofsimin ?

This will generate the package.json` file containing these:

{
  "name": "ding-dong-bot",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest to keep it for reference actually.

@Rohitesh-Kumar-Jain Rohitesh-Kumar-Jain left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for spotting and updating it : )

@proudofsimin proudofsimin left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating. Just saw that if you could change "Initialise" to "Initialize" in step 1 to stay consistent in American English. Thank you.

```bash
npm init -y
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest to keep it for reference actually.

@sbis04

sbis04 commented Jul 12, 2021

Copy link
Copy Markdown
Contributor Author

@proudofsimin I have changed "initialise" to "initialize"

@sbis04
sbis04 requested a review from shwetalsoni July 14, 2021 02:50
@sbis04

sbis04 commented Jul 29, 2021

Copy link
Copy Markdown
Contributor Author

@Rohitesh-Kumar-Jain I think this PR can be added to #1056

@lijiarui lijiarui left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lijiarui
lijiarui merged commit ca53ff7 into wechaty:master Jul 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

GSoD 2021 tutorials Related to tutorial docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants