Skip to content

Latest commit

 

History

History
107 lines (64 loc) · 3.24 KB

TECHNICAL-SETUP.md

File metadata and controls

107 lines (64 loc) · 3.24 KB
Raw

Technical Setup

To ensure you have a successful experience working with our Cosmos Cash content, Tendermint recommends this technical setup.

GitHub Integration

Click the GitHub icon in the sidebar for GitHub integration and follow the prompts.

Clone the repos you work in

Internal Tendermint users have different permissions, if you're not sure, fork the repo.

Software requirement

To build the project:

  • Golang v1.16 or higher
  • make to use Makefile targets
  • sha256sum to calculate build checksums

To run the seed scripts:

  • OS: Linux or macOS
  • jq JSON processor

For git pre-commit hooks:

Swagger

To generate the Swagger UI for the node REST endpoints:

Development environment setup

Install the configured pre-commit hooks by running these commands from the project's root folder:

$ pre-commit install
$ pre-commit install --hook-type commit-msg

Building

To build the Cosmos Cash node and command line client, run the make build command from the project's root folder. The output of the build will be generated in the build folder.

For cross-builds use the standard GOOS and GOARCH env vars. i.e. to build for windows:

GOOS=windows GOARCH=amd64 make build

💡 You can also use the default go command to build the project. For reference, see the contents of the Makefile.

⚠️ on Windows, the sha256sum command is not present so although the make build command builds successfully, it fails to compute the checksum and does not copy the other resources to the build folder.

Testing

To run the unit and integration tests, run the make test command from the project's root folder.

💡 you can also use the default go command to build the project, check the content of the Makefile for reference

Installation

To install the node client on your local machine, run the make install command from the project's root folder.

💡 you can also use the default go command to build the project, check the content of the Makefile for reference

Documentation Portal

All code updates are not complete until accompanying documentation is submitted.

The documentation portal is generated using mkdocs, to build or run the documentation portal locally the requirements are:

  • Python v3.8 or higher

Then, from the command line install the required packages

pip install mkdocs 
pip install mkdocs-material
pip install mkdocs-build-plantuml-plugin

To build the documentation portal, execute the following command from the project root:

mkdocs build

The documentation portal is built in the site directory.

To run the documentation portal, execute the following command from the project root:

mkdocs serve

The portal will be served on 'http://127.0.0.1:8000/'