Skip to content

Commit

Permalink
Document "yarn pack" command
Browse files Browse the repository at this point in the history
  • Loading branch information
kj4ezj committed Jul 6, 2024
1 parent 33d271b commit f648c06
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ You can see it live at [https://stake.eosnetwork.com](https://stake.eosnetwork.c
1. [Initialization](#initialization)
1. [Build](#build)
1. [Start](#start)
1. [Pack](#pack)
1. [See Also](#see-also)

<!-- contents markdown end -->
Expand Down Expand Up @@ -80,6 +81,35 @@ yarn start

Press `[Ctrl]` + `[C]` to stop the server.

### Pack
You can pack the build products into a `*.tgz` archive for easy distribution.
```bash
yarn pack
```
This will generate a `*.tgz` archive in the root of the repo with a structure like this.
```
eosnetwork-rex-staking-v0.0.1.tgz
└── package
├── build
│   ├── abis
│   │   └── eosio.system.abi
│   ├── _app
│   │   ├── env.js
│   │   ├── immutable
│   │   │   ├── assets
│   │   │   ├── chunks
│   │   │   ├── entry
│   │   │   └── nodes
│   │   └── version.json
│   ├── favicon.png
│   ├── index.html
│   └── ogimage.png
├── LICENSE
├── package.json
└── README.md
```
This is useful for sharing the project with others or for deploying it to a server, but is in no way required for the site to function.

## See Also
More resources.
- [aws-cloudwatch-alarm-handler](https://github.com/eosnetworkfoundation/aws-cloudwatch-alarm-handler) lambda
Expand Down

0 comments on commit f648c06

Please sign in to comment.