From f404526230c2b4994d1d2a74a19ef8e878eb5764 Mon Sep 17 00:00:00 2001 From: Bolaji Ahmad <56865496+bolajahmad@users.noreply.github.com> Date: Sun, 29 Oct 2023 11:33:50 +0100 Subject: [PATCH] update: made updates top the readme documentations --- README.md | 30 ++++++++++++------------------ 1 file changed, 12 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 536ce38..f6174f7 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,6 @@ Cover Image ---- - This is built on [`useInkathon` React Hooks](https://github.com/scio-labs/use-inkathon) that abstract & improve the polkadot.js experience. By [Bolaji Ahmad](https://linkedin.com/in/bolajahmad) 🪄 @@ -22,9 +20,9 @@ By [Bolaji Ahmad](https://linkedin.com/in/bolajahmad) 🪄 1. [Start the Frontend](#frontend-quickstart) 2. [Running the contracts](#run-the-contracts) 3. [VSCode Setup](#vscode-setup) -6. [Customization](#customization) -7. [Environmnent Variables](#env-variables) -8. [FAQs \& Troubleshooting](#faqs--troubleshooting) +3. [Customization](#customization) +4. [Environmnent Variables](#env-variables) +5. [FAQs \& Troubleshooting](#faqs--troubleshooting) --- @@ -47,7 +45,6 @@ By [Bolaji Ahmad](https://linkedin.com/in/bolajahmad) 🪄 - ## Setup and Installation 🚨 This repository contains code for the Proownas DAO Decentralized application. More information about the DAO can be found in (the DAO doc)[packages/contracts/README.md]. @@ -77,7 +74,6 @@ Assuming you have NodeJS installed, Installed pnpm also (the project is managed To run the frontend successfully, be sure to update the `NEXT_PUBLIC_WEB3STORAGE_TOKEN` with a token of your choice, or contact (bjahmad4tech@gmail.com)[mailto:bjahmad4tech@gmail.com] - ### Running the contract ```bash @@ -107,7 +103,6 @@ pnpm test ``` - ### VSCode Setup #### Workspace @@ -132,21 +127,20 @@ I strongly recommend installing all plugins listed inside `.vscode/extensions.js - ## Environment Variables -The only mandatory environment variable you need to add is `NEXT_PUBLIC_WEB3STORAGE_TOKEN`. Just set it to *_YOUR-API-KEY-FROM-WEB3STORAGE_* as there are defaults for other values. +The only mandatory environment variable you need to add is `NEXT_PUBLIC_WEB3STORAGE_TOKEN`. Just set it to _*YOUR-API-KEY-FROM-WEB3STORAGE*_ as there are defaults for other values. Please see all pre-defined environment variables below and find more info in [`packages/frontend/.env.local.example`](https://github.com/scio-labs/inkathon/blob/main/packages/frontend/.env.local.example). All available blockchain network identifiers are defined in the [`useInkathon` repository](https://github.com/scio-labs/use-inkathon/blob/main/src/chains.ts). -| Environment Variable | Value | -| ------------------------------ | ------------------------------ | -| `NEXT_PUBLIC_PRODUCTION_MODE` | `true` | -| `NEXT_PUBLIC_URL` | `https://localhost:3000` | -| `NEXT_PUBLIC_DEFAULT_CHAIN` | `shibuya` | -| `NEXT_PUBLIC_SUPPORTED_CHAINS` | `["alephzero-testnet", "shibuya"]`| -| `NEXT_PUBLIC_WEB3STORAGE_TOKEN`| `YOUR-API-KEY-FROM-WEB3STORAGE` | -` | +| Environment Variable | Value | +| ------------------------------- | ---------------------------------- | +| `NEXT_PUBLIC_PRODUCTION_MODE` | `true` | +| `NEXT_PUBLIC_URL` | `https://localhost:3000` | +| `NEXT_PUBLIC_DEFAULT_CHAIN` | `shibuya` | +| `NEXT_PUBLIC_SUPPORTED_CHAINS` | `["alephzero-testnet", "shibuya"]` | +| `NEXT_PUBLIC_WEB3STORAGE_TOKEN` | `YOUR-API-KEY-FROM-WEB3STORAGE` | +| ` | ### Contract Deployment