docs: add Quick Start With Jest - Githubissues

near / near-workspaces-js

Write tests once, run them both on NEAR TestNet and a controlled NEAR Sandbox local environment

https://near.github.io/near-workspaces-js/

GNU General Public License v3.0

42 stars 22 forks source link

docs: add Quick Start With Jest #44

Closed chadoh closed 3 years ago

chadoh commented 3 years ago

People new to JavaScript do not already know how to add a JavaScript testing library/framework to their project. This separates the "Quick Start" section of the README into two sections:

"Quick Start With Jest" explains that you don't need to use Jest, but gets you up and running quickly with Jest for everyone who will find that helpful.
"How It Works" explains what near-runner does behind the scenes. The examples in this section use plain JS to help clarify the boundary between Jest and near-runner for people new to both.

Other updates that snuck in here:

Use path.join instead of strings
Update code styles to match current codebase (see https://github.com/near/runner-js/pull/38)
Get rid of runtime, prefer root (see https://github.com/near/runner-js/pull/29)
Remove references to obsolete lines (no more runtime.getAccount in this Quick Start; see https://github.com/near/runner-js/pull/10)
Mention the toJSON override (see https://github.com/near/runner-js/pull/37)