Twinner is a web-based application designed to simplify and streamline the management of Twitter contests. By automating the process of gathering eligible participants and utilizing Chainlink VRF (Verifiable Random Function) for fair and transparent winner selection, Twinner ensures an efficient and enjoyable experience for contest organizers and participants alike.
Table of Contents
- Features
- Prerequisites
- Installation
- Usage
- Contributing
- License
Features
- Automate aggregation of eligible Twitter contest participants
- Ensure fair and unbiased winner selection using Chainlink VRF
- Enhance transparency through verifiable blockchain transactions
- Provide a user-friendly web interface for contest management
Prerequisites Before getting started with Twinner, ensure you have the following software installed on your system:
- Node.js (LTS version recommended)
- npm (included with Node.js)
- Git Additionally, you will need a Twitter Developer account with API access, and a Chainlink node with VRF capabilities for the smart contract.
Installation
- Clone the repository: bash
Copy code git clone https://github.com/your-username/twinner.git cd twinner 2. Install the required dependencies: bash
Copy code npm install 3. Create a .env file in the project root and populate it with your Twitter API credentials and the smart contract information: bash
Copy code TWITTER_API_KEY=your_twitter_api_key TWITTER_API_SECRET_KEY=your_twitter_api_secret_key TWITTER_ACCESS_TOKEN=your_twitter_access_token TWITTER_ACCESS_TOKEN_SECRET=your_twitter_access_token_secret CHAINLINK_VRF_COORDINATOR=your_chainlink_vrf_coordinator_address CHAINLINK_VRF_KEY_HASH=your_chainlink_vrf_key_hash 4. Compile and deploy the smart contract: bash
Copy code truffle compile truffle migrate --network your_network_name 5. Build the frontend application: bash
Copy code npm run build
Usage
- Start the backend server: bash
Copy code npm run server 2. In a separate terminal window, start the frontend development server: bash
Copy code npm start
-
Open your web browser and navigate to http://localhost:3000 to access the Twinner application.
-
To run a Twitter contest, simply enter the URL of your contest tweet, and Twinner will automatically aggregate the eligible participants and use Chainlink VRF to select a winner.
Contributing We welcome contributions to Twinner! To contribute, please follow these steps:
- Fork the repository
- Create a new branch for your feature or bugfix (git checkout -b feature/your-feature)
- Commit your changes (git commit -am 'Add your feature')
- Push your changes to the branch (git push origin feature/your-feature)
- Create a new pull request Please make sure your code follows the project's style guidelines and includes appropriate tests and documentation.
License Twinner is released under the MIT License.