Skip to content

Commit

Permalink
update: made updates top the readme documentations
Browse files Browse the repository at this point in the history
  • Loading branch information
bolajahmad committed Oct 29, 2023
1 parent 6323017 commit f404526
Showing 1 changed file with 12 additions and 18 deletions.
30 changes: 12 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@

<img src="assets/DAO-contract-basic-flow.png" width="400" height="200" alt="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) 🪄
Expand All @@ -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)

---

Expand All @@ -47,7 +45,6 @@ By [Bolaji Ahmad](https://linkedin.com/in/bolajahmad) 🪄

</details>


## 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].
Expand Down Expand Up @@ -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 ([email protected])[mailto:[email protected]]


### Running the contract

```bash
Expand Down Expand Up @@ -107,7 +103,6 @@ pnpm test

```


### VSCode Setup

#### Workspace
Expand All @@ -132,21 +127,20 @@ I strongly recommend installing all plugins listed inside `.vscode/extensions.js

</details>


## 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

Expand Down

0 comments on commit f404526

Please sign in to comment.