Skip to content

eosnetworkfoundation/rex-staking-portal

Repository files navigation

Rex Staking Portal

This is a staking UI for EOS REX built in SvelteKit.

It simplifies the process of staking, un-staking, and claiming rewards post-tokenomics-2 upgrade.

You can see it live at https://stake.eosnetwork.com.

Contents

  1. Development
    1. Prerequisites
    2. Initialization
    3. Build
    4. Start
    5. Pack
  2. See Also

Development

Start here to build this project or to contribute to this repo.

yarn dev

Note

The source of truth for the version of nodeJS this project supports is the .nvmrc file. Backward- or forward-compatibility with other versions of node is made on a best-effort basis, but is not guaranteed.

Prerequisites

You will need the following tools:

  • nvm
  • nodeJS
    Install node using nvm. In the root of this repo:
    nvm install
    This will automagically install and use the correct version of node for this project, as defined in the .nvmrc file.
  • yarn version 1
    The easiest way to install this is using npm, which is installed with node by nvm.
    npm install --global yarn

These tools are all you need to get started!

Initialization

Once you have the prerequisites installed, you can get going by making sure nvm is using the correct version of nodeJS...

nvm install

...and then downloading all project dependencies.

yarn

Easy.

Build

This is how release artifacts are generated.

yarn build

The "build" generates a build folder in the root of the repo that can be uploaded directly to AWS S3 using the web console, AWS CLI, or with something like Terraform Tofu.

Start

Running this...

yarn start

...uses the Caddy 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.

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

Pack

You can pack the build products into a *.tgz archive for easy distribution.

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.


Legal Notice
This repo contains assets created in collaboration with a large language model, machine learning algorithm, or weak artificial intelligence (AI). This notice is required in some countries.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published