From 53805d5d0483fd1cc64f6671e1f5dbc2f1a86da9 Mon Sep 17 00:00:00 2001 From: Torresmorah Date: Wed, 27 Jul 2022 13:49:48 -0600 Subject: [PATCH 1/5] feat(readme): update installation steps --- README.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3127df02..dd7e87bc 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,9 @@ This project use all the latest tools and practices in the industry - **[docker-compose](https://docs.docker.com/compose/)** Compose is a tool for defining and running multi-container Docker applications +- **[demux](https://guide.eoscostarica.io/docs/eos-learn/demux-pattern)** + Demux is an architectural pattern for backend infrastructure for build applications on EOSIO blockchain to sourcing blockchain events to deterministically update queryable databases. + ### File Structure Within the download you'll find the following directories and files: @@ -87,7 +90,16 @@ eosio-dashboard/ │ ├── Dockerfile │ ├── yarn-lock.json │ └── package.json -├── .env.example +├── .env.jungle +├── .env.lacchain +├── .env.local +├── .env.mainnet +├── .env.proton +├── .env.protontestnet +├── .env.telos +├── .env.telostestnet +├── .env.ultratestnet +├── .env.waxtestnet ├── .gitignore ├── docker-compose.yaml ├── .LICENSE @@ -110,13 +122,15 @@ Somethings you need before getting started: - [git](https://git-scm.com/) - [node.js](https://nodejs.org/es/) +- [yarn](https://yarnpkg.com/) - [Hasura CLI](https://hasura.io/docs/1.0/graphql/manual/hasura-cli/install-hasura-cli.html#install-hasura-cli) ### First time -1. Clone this repo using `git clone --depth=1 https://github.com/eoscostarica/eosio-dashboard.git ` -2. Move to the appropriate directory: `cd `. -3. Copy the `.env.example` then update the environment variables according to your needs +1. Clone this repo using `git clone --depth=1 https://github.com/eoscostarica/eosio-dashboard.git `. +1. Move to the appropriate directory: `cd `. +1. As EOSIO dashboard can have different configurations copy the environment variables according to your needs in the `.env` file or use `make run ` to use a configuration for a specific network. + ``` # global @@ -178,7 +192,7 @@ REACT_APP_STATE_HISTORY_ENABLED=false ### Quick start -At this point you can run `make run`, you can check the services runing on: +At this point you can run `make start` or `make run `, you can check the services runing on: - hapi at http://localhost:9090 - hasura at http://localhost:9695 From d38037ad88148b3b74ed011e4f10e0171d9276af Mon Sep 17 00:00:00 2001 From: Torresmorah Date: Wed, 3 Aug 2022 09:55:55 -0600 Subject: [PATCH 2/5] feat(readme): add windows considerations --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dd7e87bc..4accfc54 100644 --- a/README.md +++ b/README.md @@ -125,6 +125,12 @@ Somethings you need before getting started: - [yarn](https://yarnpkg.com/) - [Hasura CLI](https://hasura.io/docs/1.0/graphql/manual/hasura-cli/install-hasura-cli.html#install-hasura-cli) +#### Considerations for Windows + +If you are using Windows you need to install [WSL](https://docs.microsoft.com/en-us/windows/wsl/install) in version 2, to install a Linux distribution on Windows for run the project. In the Linux distribution is where you need to install git, node, yarn and Hasura CLI. + +Additionally, you need WSL to use Docker Desktop as an intermediate between Windows and the Linux distribution. Otherwise, if you have a computer with low hardware specifications, it's recommended to use Linux instead of Windows with WSL. + ### First time 1. Clone this repo using `git clone --depth=1 https://github.com/eoscostarica/eosio-dashboard.git `. @@ -194,7 +200,7 @@ REACT_APP_STATE_HISTORY_ENABLED=false At this point you can run `make start` or `make run `, you can check the services runing on: -- hapi at http://localhost:9090 +- hapi at http://localhost:9090/healthz - hasura at http://localhost:9695 - webapp at http://localhost:3000 From fc852957d8f1e7d6902c5f1d346500f7c3cb4c80 Mon Sep 17 00:00:00 2001 From: Helbertson Torres <66583677+Torresmorah@users.noreply.github.com> Date: Wed, 3 Aug 2022 11:23:35 -0600 Subject: [PATCH 3/5] feat(readme): add libre and libretestnet to the list of env files --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 4accfc54..6880f502 100644 --- a/README.md +++ b/README.md @@ -93,6 +93,8 @@ eosio-dashboard/ ├── .env.jungle ├── .env.lacchain ├── .env.local +├── .env.libre +├── .env.libretestnet ├── .env.mainnet ├── .env.proton ├── .env.protontestnet From 9fe79d6296b565f218d080bd8a1c06583e86ea10 Mon Sep 17 00:00:00 2001 From: Fabian Vives <55892352+fvives99@users.noreply.github.com> Date: Wed, 3 Aug 2022 11:47:41 -0600 Subject: [PATCH 4/5] feat(readme): logo and grammar check --- README.md | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 6880f502..d8ef3498 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,16 @@ -

+

-

-
-[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) ![GitHub](https://img.shields.io/github/license/eoscostarica/eosio-dashboard) ![GitHub repo size](https://img.shields.io/github/repo-size/eoscostarica/eosio-dashboard) ![Twitter Follow](https://img.shields.io/twitter/follow/eoscostarica?style=social) ![GitHub forks](https://img.shields.io/github/forks/eoscostarica/eosio-dashboard?style=social) +[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) +![GitHub](https://img.shields.io/github/license/eoscostarica/eosio-dashboard) +![GitHub repo size](https://img.shields.io/github/repo-size/eoscostarica/eosio-dashboard) +[![Twitter Follow](https://img.shields.io/twitter/follow/eoscostarica?style=social)](https://twitter.com/EOSCostaRica) +![GitHub forks](https://img.shields.io/github/forks/eoscostarica/eosio-dashboard?style=social) + +
# EOSIO Dashboard Network and Infrastructure Dashboard for EOSIO networks. @@ -118,10 +122,11 @@ There are some important folders like Basic knowledge about Docker, Docker Compose and NodeJS is required. -### Before you start +### Getting Started -Somethings you need before getting started: +Some things you need before getting started: +- [docker](https://www.docker.com/) - [git](https://git-scm.com/) - [node.js](https://nodejs.org/es/) - [yarn](https://yarnpkg.com/) @@ -129,7 +134,7 @@ Somethings you need before getting started: #### Considerations for Windows -If you are using Windows you need to install [WSL](https://docs.microsoft.com/en-us/windows/wsl/install) in version 2, to install a Linux distribution on Windows for run the project. In the Linux distribution is where you need to install git, node, yarn and Hasura CLI. +If you are using Windows you need to install [WSL](https://docs.microsoft.com/en-us/windows/wsl/install) in version 2 and install a Linux distribution on Windows to run the project. In the Linux distribution is where you need to install git, node, yarn and Hasura CLI. Additionally, you need WSL to use Docker Desktop as an intermediate between Windows and the Linux distribution. Otherwise, if you have a computer with low hardware specifications, it's recommended to use Linux instead of Windows with WSL. @@ -221,13 +226,13 @@ Contributions of any kind welcome! ## About EOS Costa Rica -

- - +

+ + -

-
-EOS Costa Rica is an independently-owned, self-funded, bare-metal Genesis block producer that provides stable and secure infrastructure for EOSIO blockchains. We support open source software for our community while offering enterprise solutions and custom smart contract development for our clients. +
+EOS Costa Rica is an independently-owned, self-funded, bare-metal Genesis block producer that provides stable and secure infrastructure for EOSIO blockchains. We support open source software for our community while offering enterprise blockchain development and custom smart contract development for our clients. -[eoscostarica.io](https://eoscostarica.io) Support OpenSource! +[eoscostarica.io](https://eoscostarica.io/) From 35cb80fe9a9e0c340ea326bacac909746da32df0 Mon Sep 17 00:00:00 2001 From: Fabian Vives <55892352+fvives99@users.noreply.github.com> Date: Wed, 3 Aug 2022 11:48:16 -0600 Subject: [PATCH 5/5] feat(readme): minor grammar --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d8ef3498..bfa097fa 100644 --- a/README.md +++ b/README.md @@ -222,7 +222,7 @@ Please Read EOS Costa Rica's [Open Source Contributing Guidelines](https://devel Please report bugs big and small by [opening an issue](https://github.com/eoscostarica/eosio-dashboard/issues/new/choose) -Contributions of any kind welcome! +Contributions of any kind are welcome! ## About EOS Costa Rica