Skip to content

Commit

Permalink
apply documentation for app
Browse files Browse the repository at this point in the history
  • Loading branch information
synasapmob committed Oct 13, 2023
1 parent 82e47b8 commit 46e02dc
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions documentation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<div align="center">
<img src="https://user-images.githubusercontent.com/67900234/205422369-4ee51a5a-1822-4da2-bd21-055cd0b40230.svg" width="600" >
</div>

<br />

## 1. How to installation?

Create apps with no build configuration.<br />
If something doesn't work, [file an issue](https://github.com/grindytech/gafi/issues).<br />
to run you just start the command below

```sh
git clone -b dev https://github.com/grindytech/gafi-app.git
cd gafi-app
yarn install
yarn dev
```

<div>
<img src="https://drive.google.com/uc?export=view&id=104-mZ_hZ8KSoA6Z7uf5daWG3kjtp0t1G" />
</div>

## 2. How to use?

If you wish to explore the application in detail, please connect a wallet, such as
[Polkadot](https://polkadot.js.org/extension/),
[Clover](https://docs.clv.org/use-clv-wallet/download-clv-wallet),
or [Subwallet](https://www.subwallet.app/download.html)<br />
As a guest you can only preview the application interaction with the app's features is not available.<br />
To learn more, please refer to our [documentation](https://wiki.gafi.network/learn/web3-gaming).<br />

The following is a guide to using the application:

## 3. How to test

Before deployment, crucial applications must pass unit testing to ensure functionality <br />
and prevent bugs. also ensuring user satisfaction. <br />
To better understand unit testing techniques for resolving [issues](https://jestjs.io/docs/getting-started)

```sh
git clone -b dev https://github.com/grindytech/gafi-app.git
cd gafi-app
yarn install
yarn test
```

<div>
<img src="https://drive.google.com/uc?export=view&id=1E1Y3sF2l4cut36CqxAD0kNYcJiVJLgrS" />
<img src="https://drive.google.com/uc?export=view&id=1_YXP9x84Psie_BreOs5h0jd6rZV0HgKz" width="100%" />
</div>

0 comments on commit 46e02dc

Please sign in to comment.