diff --git a/.npmrc b/.npmrc deleted file mode 100644 index b6f27f1..0000000 --- a/.npmrc +++ /dev/null @@ -1 +0,0 @@ -engine-strict=true diff --git a/README.md b/README.md index 4f4ab8f..c8041f9 100644 --- a/README.md +++ b/README.md @@ -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) @@ -76,10 +77,39 @@ Running this... ```bash yarn start ``` -...uses [Caddy](https://caddyserver.com) in `file_server` mode to publish the build artifacts in the `build` folder in the root of the repo at port `8443` to emulate an S3 bucket. You can load this in your browser by navigating to [https://localhost:8443](https://localhost:8443). +...uses the [Caddy](https://caddyserver.com) docker container in `file_server` mode to publish the build artifacts in the `build` folder in the root of the repo at port `8443` to emulate an S3 bucket. You can load this in your browser by navigating to [https://localhost:8443](https://localhost:8443). 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 diff --git a/package.json b/package.json index 9eeef09..a4c17ce 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,17 @@ { "name": "@eosnetwork/rex-staking", "version": "0.0.1", + "description": "Static Svelte website that simplifies the process of staking, un-staking, and claiming EOS REX rewards post-tokenomics-2 upgrade.", + "repository": "git@github.com:eosnetworkfoundation/rex-staking-portal.git", + "homepage": "https://github.com/eosnetworkfoundation/rex-staking-portal", + "author": { + "name": "EOS Network Foundation Automation", + "email": "webmaster@eosnetwork.com", + "url": "https://eosnetwork.com" + }, + "license": "MIT", "private": true, + "engineStrict": true, "scripts": { "build": "vite build", "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json", @@ -11,6 +21,9 @@ "reset": "scripts/reset.sh", "start": "scripts/start.sh" }, + "files": [ + "build" + ], "devDependencies": { "@sveltejs/adapter-auto": "^3.0.0", "@sveltejs/adapter-netlify": "^4.2.0",