Skip to content

Commit

Permalink
chore: update readme and add example env file (#1395)
Browse files Browse the repository at this point in the history
  • Loading branch information
charymalloju authored Aug 22, 2024
2 parents da48cd0 + ae9cb8f commit 3b3e386
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,13 @@ $ yarn

## Environment variables

Create .env file and set multisig backend URI `NEXT_PUBLIC_APP_API_URI`
Rename `.env.example` to `.env` and set multisig backend URI `NEXT_PUBLIC_APP_API_URI`,
You can setup your own multisig server in [Set up multisig server](./MULTISIG_SERVER_README.md).

Set Squid ID `NEXT_PUBLIC_SQUID_ID`, You can get Squid ID from here [Squid ID](https://squidrouter.typeform.com/integrator-id?typeform-source=docs.squidrouter.com)

To use Cosmwasm contracts set `NEXT_PUBLIC_DUMMY_WALLET_MNEMONIC`.

## Start in DEV Mode
Runs the app in the development mode.<br />
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
Expand Down
4 changes: 4 additions & 0 deletions frontend/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
NEXT_PUBLIC_APP_API_URI=<Backend URI>
NEXT_PUBLIC_SQUID_ID=<SQUID ID>
# To use Cosmwasm contracts provide the dummy wallet mnemonic, create a dummy wallet and add mnemonic here, also have minimum tokens in this wallet.
NEXT_PUBLIC_DUMMY_WALLET_MNEMONIC=<Dummy mnemonic for cosmwasm contract>
2 changes: 2 additions & 0 deletions server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ This module provides backend code for [Resolute](https://resolute.vitwit.com), a

For configuration we use YAML file format. To configure `backend` and `database`, you need to add `config.yaml` file. Reference `example.yaml`.

To get the transactions history you need to add your chain details in `server/networks.json` file.

## Database setup

This project uses Postgres database. Before starting the server make sure to initialize database tables. You can find schema [Here](https://github.com/vitwit/resolute/server/schema/schema.sql).
Expand Down

0 comments on commit 3b3e386

Please sign in to comment.