github.com/line/ostracon@v1.0.10-0.20230328032236-7f20145f065d/README.md (about)

     1  # Ostracon
     2  
     3  ![example workflow](https://github.com/line/ostracon/actions/workflows/build.yml/badge.svg)
     4  ![example workflow](https://github.com/line/ostracon/actions/workflows/coverage.yml/badge.svg)
     5  
     6  [Ostracon](docs/en/01-overview.md "Ostracon: A Fast, Secure Consensus Layer for The Blockchain of New Token Economy")
     7  is forked from Tendermint Core [v0.34.19](https://github.com/tendermint/tendermint/tree/v0.34.19) at 2021-03-15.
     8  
     9  **Node**: Requires [Go 1.18+](https://golang.org/dl/)
    10  
    11  **Warnings**: Initial development is in progress, but there has not yet been a stable.
    12  
    13  [](docs/en/01-overview.md)
    14  
    15  # Quick Start
    16  
    17  ## git clone
    18  ```shell
    19  git clone https://github.com/line/ostracon.git
    20  # or
    21  git clone git@github.com:line/ostracon.git
    22  ```
    23  
    24  ### git clone with recursive if you want to use libsodium
    25  ```shell
    26  git clone --recursive https://github.com/line/ostracon.git
    27  # or
    28  git clone --recursive git@github.com:line/ostracon.git
    29  ```
    30  
    31  ### git submodule if you forget to clone with submodule
    32  ```shell
    33  git submodule update --init --recursive
    34  ```
    35  
    36  ## Local Standalone
    37  **Build**
    38   ```sh
    39   make build     # go help build
    40   make install   # go help install
    41   ```
    42  
    43  **Run**
    44   ```sh
    45   ostracon init
    46   ostracon node --proxy_app=kvstore                # Run a node
    47   ```
    48  
    49  Before running it, don't forget to cleanup the old files:
    50   ```sh
    51   # Clear the build folder
    52   rm -rf ~/.ostracon
    53   ```
    54  
    55  **Visit with your browser**
    56  * Node: http://localhost:26657/
    57  
    58  ## Localnet(4 nodes) with Docker
    59  **Build Docker Image**
    60  
    61  (optionally) Build the linux binary for localnode in ./build
    62   ```sh
    63   make build-localnode
    64   ```
    65  (optionally) Build ostracon/localnode image
    66   ```sh
    67   make build-localnode-docker
    68   ```
    69  
    70  **Run localnet**
    71  
    72  To start 4 nodes
    73   ```sh
    74   make localnet-start
    75   ```
    76  
    77  Before running it, don't forget to cleanup the old files
    78   ```sh
    79   rm -rf ./build/node*
    80   ```
    81  
    82  **Visit with your browser**
    83  * Node: http://localhost:26657/
    84  
    85  ## Linux Docker
    86  **Build Docker Image**
    87  
    88  Build the linux binary
    89   ```sh
    90   make build-linux-docker
    91   ```
    92  
    93  **Run a linux docker node**
    94  
    95  To start a linux node
    96   ```sh
    97   make standalone-linux-docker
    98   ```
    99  
   100  **Visit with your browser**
   101  * Node: http://localhost:26657/