/space-pirates-frontend

Space Pirates frontend

Primary LanguageTypeScriptMIT LicenseMIT

Space Pirates Frontend

Getting started

  • Create a .env.development.local file with the following content:

    TRON_PRIVATE_KEY = <key>

NEXT_PUBLIC_BANK_KEY = <key>

# if empty will fallback to https://api.shasta.trongrid.io
TRON_WEB_NODE = https://api.trongrid.io

NEXT_PUBLIC_NPC_ADDRESS = <base58_address>
NEXT_PUBLIC_NPC_PRIVATE_KEY = <key>

    The Tron Grid key is obtainable on the TronGrid website. The private key from a wallet.

  • Install the TronLink extension.

  • Install dependencies with yarn install and run the development server with yarn dev.

Git hooks

On every commit Husky executes two Git hooks:

  • commit-msg: ensure that the commit message follows the Convetional Commit Format
  • pre-commit: run yarn lint and yarn format:check. In case some files aren't well-formatted, you can manually execute yarn format:write to format them.

Contribution guidelines

Current development status can be consulted in the Github Project section. Pick one of the open issues or tasks and follow the instructions below:

  1. Fork the Project

  2. Follow the instructions in getting started

  3. Create your Feature Branch (git checkout -b feature/AmazingFeature)

  4. Commit your Changes (git commit -m 'feat: AmazingFeature'). Use the Conventional Commits format.

  5. Push to the Branch (git push origin feature/AmazingFeature)

  6. Open a Pull Request