Skip to content
This repository has been archived by the owner on Jan 12, 2021. It is now read-only.

Commit

Permalink
docs(readme): add local setup info
Browse files Browse the repository at this point in the history
  • Loading branch information
pheekus committed Apr 6, 2020
1 parent 8f3c9e1 commit 0a52c79
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,3 +148,25 @@ await store.fetch({
```ts
await store.fetch({ method: "DELETE" });
```

## Development

To get started, clone this repo locally and install the dependencies:

```bash
git clone https://github.com/foxy/foxy-node-api.git
npm install
```

Running tests:

```bash
npm run test # runs all tests and exits
npm run test:watch # looks for changes and re-runs tests as you code
```

Committing changes with [commitizen](https://github.com/commitizen/cz-cli):

```bash
git commit # precommit hooks will lint the staged files and help you format your message correctly
```

0 comments on commit 0a52c79

Please sign in to comment.