diff --git a/README.md b/README.md index b3a2067..9e735a8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,59 @@ -# ๐Ÿ— Scaffold-ETH 2 +# Reputation & Roles + +An open-source toolkit used to quickly and easily deploy your own Reputation & Roles smart contracts along with a decentralized application to interact with them. + +## Quickstart + +To get started with Reputation & Roles, follow the steps below: + +1. Clone this repo & install dependencies + +``` +git clone https://github.com/atxdao/reputation-and-roles-monorepo.git +cd reputation-and-roles-monorepo +yarn install +``` + +1. On the first terminal, start your NextJS app: + +``` +yarn start +``` + +Visit your app on: `http://localhost:3000`. + +Connect a burner wallet. +Copy the wallet address. +Return to your code editor, navigate to `~/packages/foundry/script/DeployDemo.s.sol`, and replace the value of the `controller` variable with your copied wallet address. + + +2. Run a local network on your second terminal: + +``` +yarn chain +``` + +This command starts a local Ethereum network using Hardhat. The network runs on your local machine and can be used for testing and development. + +3. On a third terminal, deploy the test contract: + +``` +yarn deployDemo +``` + +This command deploys a test smart contract to the local network. The contract is located in `packages/foundry/lib/reputation/src/ReputationTokensStandalone`. +The `yarn deploy` command uses the deploy script located in `packages/foundry/script/DeployDemo.s.sol` to deploy the contract to the network. You can also customize the deploy script. + +4. View results on webpage + +Re-visit your app on: `http://localhost:3000`. +Refresh the page if you need to! + +On the home page, you should see many colorful and variable cards and widgets which display your Reputation Tokens in full force! +By navigating to the `Debug Contracts` page, you can interact with and view the properties of your deploy Reputation system! + + + \ No newline at end of file