diff --git a/README.md b/README.md index 79abb5acf..3237d6376 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,57 @@ # Dash Platform Explorer -![image](assets/screenshot.png) +![Dash](https://img.shields.io/badge/dash-008DE4?style=for-the-badge&logo=dash&logoColor=white) +![Rust](https://img.shields.io/badge/rust-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white) +![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white) +![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB) -Supports: +![a](https://github.com/pshenmic/platform-explorer/actions/workflows/build.yml/badge.svg) +###**Platform Explorer** + +Index and explore Dash Platform (Evolution) chain data, continuously parsing blockchain in the background. + +Main features: * Data Contracts with schemas * Documents with data -* Searching and listing APIs -* Dash Platform v25+ +* Search and list the data +* Supports last Dash Platform release (testnet) -## Initial setup +## Prerequisites +* PostgreSQL +* Rust 1.73+ +* Node.js 18+ +* Tenderdash (RPC) -Project requires an PostgreSQL and Tenderdash RPC. +To access Tenderdash RPC, you will need a dash evonode fullnode instance running. You can get it via starting your node with the [dashmate](https://github.com/dashpay/platform/tree/master/packages/dashmate "dashmate") (testnet or local dev node) -To access Tenderdash RPC, you will need an instance running. -You can get it via starting your node with the `dashmate` (testnet or local dev node) +Example: +```bash +dashmate setup testnet fullnode +dashmate start +dashmate status core +dashmate status platform +``` -### 1) Start indexer +Once synced, your Tenderdash RPC will be accessible at http://127.0.0.1:36657 -Edit `packages/indexer/.env` and fill with your PostgreSQL credentials and Tenderdash RPC URL, then do: +### Running (only dev) +#### _only dev mode is implemented atm_ + +### Indexer + +Verify `packages/indexer/.env` with your PostgreSQL credentials and Tenderdash RPC URL, then do: ```bash cd packages/indexer cargo run ``` -An indexer should start fetching blocks from the TD and continuously insert the data in the database +After successful build, indexer should start and connect to the Tenderdash RPC and start persisting chain data into PostgreSQL -### 2) Run backend +### Backend -Edit `packages/api/.env` and fill with your PostgreSQL credentials, then do: +Verify `packages/api/.env` with your PostgreSQL credentials and TenderdashRPC URLs, then do: ``` cd packages/api @@ -37,11 +59,9 @@ npm install npm start ``` -### 3) Start frontend - -##### If you want to use local backend: +### Frontend -Set `REACT_APP_API_BASE_URL=http://127.0.0.1:3005` in the `packages/frontend/.env` +Verify your `packages/frontend/.env` is matching your backend API URL Then: ``` diff --git a/assets/screenshot.png b/assets/screenshot.png deleted file mode 100644 index 09bc83fff..000000000 Binary files a/assets/screenshot.png and /dev/null differ