{"id":29219843,"url":"https://github.com/protofire/simplestate-ui","last_synced_at":"2025-07-03T02:07:40.221Z","repository":{"id":65041502,"uuid":"565879360","full_name":"protofire/simplestate-ui","owner":"protofire","description":null,"archived":false,"fork":false,"pushed_at":"2023-02-06T12:33:03.000Z","size":428,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2023-05-16T23:26:35.803Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://simplestate.netlify.app/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/protofire.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-11-14T14:18:33.000Z","updated_at":"2023-01-31T20:57:04.000Z","dependencies_parsed_at":"2023-02-19T07:31:20.713Z","dependency_job_id":null,"html_url":"https://github.com/protofire/simplestate-ui","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"purl":"pkg:github/protofire/simplestate-ui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protofire%2Fsimplestate-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protofire%2Fsimplestate-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protofire%2Fsimplestate-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protofire%2Fsimplestate-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/protofire","download_url":"https://codeload.github.com/protofire/simplestate-ui/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/protofire%2Fsimplestate-ui/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263245315,"owners_count":23436515,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-03T02:07:39.592Z","updated_at":"2025-07-03T02:07:40.208Z","avatar_url":"https://github.com/protofire.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Simplestate UI\n\nReal estate tokenization UI.\n\n### Running this project\n\n1. Create an [Achemy](https://dashboard.alchemy.com/) account. Under dashboard select \"Create App\" for the corresponding network.\n   - Polygon Mumbai for testing.\n   - Polygon for prod.\n---\n\n2. Install dependencies.\n\n```sh\nyarn install\n```\n---\n\n3. Create an `.env` file at the root folder of the project and set the following variables\n\n```sh\nVITE_REGISTRY_CONTRACT_ADDRESS='0x...'\nVITE_FACTORY_CONTRACT_ADDRESS='0x...'\nVITE_UNDERLYING_TOKEN_ADDRESS='0x...' # USDS\nVITE_RENT_INCOME_CONTRACT_ADDRESS='0x...'\nVITE_SIMPLEARN_CONTRACT_ADDRESS='0x...'\nVITE_ALCHEMY_ENDPOINT='https://polygon-mainnet.g.alchemy.com/v2/...' # the endpoint for your Alchemy app.\nVITE_CHAIN_ID=80001 # 80001 for mumbai testnet, 137 for polygon mainnet\n```\n\n---\n\n4. Run in local mode \n\n```sh\nyarn dev\n```\n\n\u003e Make sure to connect your wallet in the right network (Polygon mumbai or Polygon mainnet).\n\n\n### Deployment\nYou can deploy the app to any hosting service, we recommend using [Netlify](https://www.netlify.com/) since it offers CI/CD integration + environment variables support.\n\n1. Create a netlify account.\n2. Go to [upload app dashboard](https://app.netlify.com/start).\n3. Select Github and link the existing repository to the app using `main` branch.\n4. Add environment variables present in `.env`.\n5. Trigger deploy.\n\n### Project tooling + structure\n\nWe use `vite` as the react framework following the standard structure for React applications. The UI library is `mantine` and for smart contracts interactions we use `ethers.js` library.\n\nThe Frontend interacts directly with the smart contracts (without any backend layer).\n\nUnder `pages/` folder, each sub-folder represents one tab (see UI) and its corresponding sub-components.\nUnder `hooks/` folder, we have the scripts corresponding to the metamask connection (`useMetamask`), the contracts setup (`useContract`) and the contracts interaction for performing operations on-chain (`useApi`).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprotofire%2Fsimplestate-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprotofire%2Fsimplestate-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprotofire%2Fsimplestate-ui/lists"}