generated from scaffold-eth/scaffold-eth-2
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f666f11
commit cc88aee
Showing
1 changed file
with
38 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,80 +1,79 @@ | ||
| # 🏗 Scaffold-ETH 2 | ||
| # Scaffold ETH + MACI Voting Template | ||
|
|
||
| <h4 align="center"> | ||
| <a href="https://docs.scaffoldeth.io">Documentation</a> | | ||
| <a href="https://scaffoldeth.io">Website</a> | ||
| </h4> | ||
| Welcome to the Scaffold ETH + MACI Voting Template! This template is a powerful starting point for developers aiming to build decentralized voting applications that prioritize privacy and resist collusion. Combining the rapid development environment of Scaffold ETH with the innovative Minimal Anti-Collusion Infrastructure (MACI), this template offers a robust foundation for creating secure and transparent voting systems on the Ethereum blockchain. | ||
|
|
||
| 🧪 An open-source, up-to-date toolkit for building decentralized applications (dapps) on the Ethereum blockchain. It's designed to make it easier for developers to create and deploy smart contracts and build user interfaces that interact with those contracts. | ||
| ## Features | ||
|
|
||
| ⚙️ Built using NextJS, RainbowKit, Hardhat, Wagmi, Viem, and Typescript. | ||
|
|
||
| - ✅ **Contract Hot Reload**: Your frontend auto-adapts to your smart contract as you edit it. | ||
| - 🪝 **[Custom hooks](https://docs.scaffoldeth.io/hooks/)**: Collection of React hooks wrapper around [wagmi](https://wagmi.sh/) to simplify interactions with smart contracts with typescript autocompletion. | ||
| - 🧱 [**Components**](https://docs.scaffoldeth.io/components/): Collection of common web3 components to quickly build your frontend. | ||
| - 🔥 **Burner Wallet & Local Faucet**: Quickly test your application with a burner wallet and local faucet. | ||
| - 🔐 **Integration with Wallet Providers**: Connect to different wallet providers and interact with the Ethereum network. | ||
|
|
||
|  | ||
| - **Voter Registration**: Secure registration process through the MACI contract, enabling eligible voting. | ||
| - **Poll Management**: Admins can easily create and manage polls, including question and options setup. | ||
| - **Secure Voting**: Leverage MACI's privacy-preserving technology to ensure votes are cast anonymously and securely. | ||
| - **Results Display**: Transparent display of poll results after the voting phase concludes. | ||
| - **Admin Dashboard**: Comprehensive admin interface for poll oversight, including current status and results analytics. | ||
|
|
||
| ## Requirements | ||
|
|
||
| Before you begin, you need to install the following tools: | ||
| Ensure you have the following tools installed before you proceed: | ||
|
|
||
| - [Node (>= v18.17)](https://nodejs.org/en/download/) | ||
| - Yarn ([v1](https://classic.yarnpkg.com/en/docs/install/) or [v2+](https://yarnpkg.com/getting-started/install)) | ||
| - [Git](https://git-scm.com/downloads) | ||
|
|
||
| ## Quickstart | ||
|
|
||
| To get started with Scaffold-ETH 2, follow the steps below: | ||
| Jumpstart your development with these simple steps: | ||
|
|
||
| 1. Clone this repo & install dependencies | ||
| 1. **Clone and Set Up the Project** | ||
|
|
||
| ``` | ||
| ```bash | ||
| git clone https://github.com/scaffold-eth/scaffold-eth-2.git | ||
| cd scaffold-eth-2 | ||
| yarn install | ||
| ``` | ||
|
|
||
| 2. Run a local network in the first terminal: | ||
| 2. **Start a Local Ethereum Network** | ||
|
|
||
| ``` | ||
| In your first terminal window, run: | ||
|
|
||
| ```bash | ||
| 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. You can customize the network configuration in `hardhat.config.ts`. | ||
| This initiates a local Ethereum network via Hardhat for development and testing purposes. Adjust the network settings in `hardhat.config.ts` as needed. | ||
|
|
||
| 3. On a second terminal, deploy the test contract: | ||
| 3. **Deploy Contracts** | ||
|
|
||
| ``` | ||
| In a second terminal, deploy your test contract with: | ||
|
|
||
| ```bash | ||
| yarn deploy | ||
| ``` | ||
|
|
||
| This command deploys a test smart contract to the local network. The contract is located in `packages/hardhat/contracts` and can be modified to suit your needs. The `yarn deploy` command uses the deploy script located in `packages/hardhat/deploy` to deploy the contract to the network. You can also customize the deploy script. | ||
| Find the contract in `packages/hardhat/contracts`. This script deploys your contract to the local network, with customization available in `packages/hardhat/deploy`. | ||
|
|
||
| 4. On a third terminal, start your NextJS app: | ||
| 4. **Launch the NextJS Application** | ||
|
|
||
| ``` | ||
| In a third terminal, start the NextJS frontend: | ||
|
|
||
| ```bash | ||
| yarn start | ||
| ``` | ||
|
|
||
| Visit your app on: `http://localhost:3000`. You can interact with your smart contract using the `Debug Contracts` page. You can tweak the app config in `packages/nextjs/scaffold.config.ts`. | ||
|
|
||
| Run smart contract test with `yarn hardhat:test` | ||
| Navigate to `http://localhost:3000` to interact with your dApp. Modify your app configuration in `packages/nextjs/scaffold.config.ts` as necessary. | ||
|
|
||
| - Edit your smart contract `YourContract.sol` in `packages/hardhat/contracts` | ||
| - Edit your frontend in `packages/nextjs/pages` | ||
| - Edit your deployment scripts in `packages/hardhat/deploy` | ||
| ## Usage | ||
|
|
||
| ## Documentation | ||
| After setting up the project, you can: | ||
|
|
||
| Visit our [docs](https://docs.scaffoldeth.io) to learn how to start building with Scaffold-ETH 2. | ||
| - **Register**: Use the app's interface to register with the MACI contract and gain voting rights. | ||
| - **Create Polls**: As an admin, you can create polls with custom questions and options. | ||
| - **Vote**: Registered voters can participate in polls, utilizing MACI's secure voting mechanism. | ||
| - **View Results**: Access poll outcomes after the voting phase ends. | ||
| - **Admin Dashboard**: Monitor and manage ongoing polls, including viewing detailed poll status. | ||
|
|
||
| To know more about its features, check out our [website](https://scaffoldeth.io). | ||
| ## Contributing | ||
|
|
||
| ## Contributing to Scaffold-ETH 2 | ||
| Your contributions are welcome! Feel free to report issues, submit fixes, or suggest new features to enhance the project. | ||
|
|
||
| We welcome contributions to Scaffold-ETH 2! | ||
| ## License | ||
|
|
||
| Please see [CONTRIBUTING.MD](https://github.com/scaffold-eth/scaffold-eth-2/blob/main/CONTRIBUTING.md) for more information and guidelines for contributing to Scaffold-ETH 2. | ||
| This project is licensed under the [MIT License](LICENSE). |