{"id":15927553,"url":"https://github.com/austintgriffith/bglabs-streams","last_synced_at":"2025-07-03T18:33:32.578Z","repository":{"id":186460284,"uuid":"618036206","full_name":"austintgriffith/bglabs-streams","owner":"austintgriffith","description":null,"archived":false,"fork":false,"pushed_at":"2023-03-28T15:56:12.000Z","size":1902,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-03T13:43:55.313Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/austintgriffith.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-03-23T16:09:03.000Z","updated_at":"2023-12-24T09:32:19.000Z","dependencies_parsed_at":null,"dependency_job_id":"baa1d48e-2431-4e40-a920-21a0d5c580ed","html_url":"https://github.com/austintgriffith/bglabs-streams","commit_stats":null,"previous_names":["austintgriffith/bglabs-streams"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/austintgriffith/bglabs-streams","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/austintgriffith%2Fbglabs-streams","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/austintgriffith%2Fbglabs-streams/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/austintgriffith%2Fbglabs-streams/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/austintgriffith%2Fbglabs-streams/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/austintgriffith","download_url":"https://codeload.github.com/austintgriffith/bglabs-streams/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/austintgriffith%2Fbglabs-streams/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263379522,"owners_count":23457862,"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":"2024-10-06T23:02:32.284Z","updated_at":"2025-07-03T18:33:32.554Z","avatar_url":"https://github.com/austintgriffith.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Scaffold-Eth 2\n\n⚠️ This project is currently under active development. Things might break. Feel free to check the open issues \u0026 create new ones.\n\nScaffold-Eth 2 is an open-source 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.\n\nIt's a new version of scaffold-eth with its core functionality. Built using NextJS, RainbowKit, Hardhat, Wagmi and Typescript.\n\n- ✅ **Contract Hot Reload**: Your frontend auto-adapts to your smart contract as you edit it.\n- 🔥 **Burner Wallet \u0026 Local Faucet**: Quickly test your application with a burner wallet and local faucet.\n- 🔐 **Integration with Wallet Providers**: Connect to different wallet providers and interact with the Ethereum network.\n\n## Contents\n\n- [Requirements](#requirements)\n- [Quickstart](#Quickstart)\n- [Deploying your Smart Contracts to a Live Network](#Deploying-your-Smart-Contracts-to-a-live-network)\n- [Deploying your NextJS App](#Deploying-your-NextJS-App)\n- [Disabling Type \u0026 Linting Error Checks](#Disabling-type-and-linting-error-checks)\n  * [Disabling commit checks](#Disabling-commit-checks)\n  * [Deploying to Vercel without any checks](#Deploying-to-Vercel-without-any-checks)\n  * [Disabling Github Workflow](#Disabling-Github-Workflow)\n- [Contributing to Scaffold-Eth 2](#Contributing-to-Scaffold-Eth-2)\n\n## Requirements\n\nBefore you begin, you need to install the following tools:\n- [Node (v18 LTS)](https://nodejs.org/en/download/)\n- [Yarn (v1.x)](https://classic.yarnpkg.com/en/docs/install/)\n- [Git](https://git-scm.com/downloads)\n\n## Quickstart\n\nTo get started with Scaffold-Eth 2, follow the steps below:\n\n1. Clone this repo \u0026 install dependencies\n\n```\ngit clone https://github.com/scaffold-eth/se-2.git\ncd se-2\nyarn install\n```\n\n2. Run a local network in the first terminal:\n\n```\nyarn chain\n```\n\nThis 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.js`.\n\n3. On a second terminal, deploy the test contract:\n\n```\nyarn deploy\n```\nThis 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.\n\n4. On a third terminal, start your NextJS app:\n\n```\nyarn start\n```\nVisit your app on: `http://localhost:3000`. You can interact with your smart contract using the contract component or the example ui in the frontend. You can tweak the app config in `packages/nextjs/scaffold.config.ts`.\n\nRun smart contract test with `yarn hardhat:test`\n\n- Edit your smart contract `YourContract.sol` in `packages/hardhat/contracts`\n- Edit your frontend in `packages/nextjs/pages`\n- Edit your deployment scripts in `packages/hardhat/deploy`\n\n## Deploying your Smart Contracts to a Live Network\nOnce you are ready to deploy your smart contracts, there are a few things you need to adjust.\n\n1. Select the network\n\nBy default, ```yarn deploy``` will deploy the contract to the local network. You can change the defaultNetwork in `packages/hardhat/hardhat.config.js.` You could also simply run ```yarn deploy --network target_network``` to deploy to another network.\n\nCheck the `hardhat.config.js` for the networks that are pre-configured. You can also add other network settings to the `hardhat.config.js file`. Here are the [Alchemy docs](https://docs.alchemy.com/docs/how-to-add-alchemy-rpc-endpoints-to-metamask) for information on specific networks.\n\nExample: To deploy the contract to the Sepolia network, run the command below:\n```\nyarn deploy --network sepolia\n```\n\n2. Generate a new account or add one to deploy the contract(s) from. Additionally you will need to add your Alchemy API key. Rename `.env.example` to `.env` and fill the required keys.\n\n```\nALCHEMY_API_KEY=\"\",\nDEPLOYER_PRIVATE_KEY=\"\"\n```\n\nThe deployer account is the account that will deploy your contracts. Additionally, the deployer account will be used to execute any function calls that are part of your deployment script.\n\nYou can generate a random account / private key with ```yarn generate``` or add the private key of your crypto wallet. ```yarn generate``` will create a random account and add the DEPLOYER_PRIVATE_KEY to the .env file. You can check the generated account with ```yarn account```.\n\n3. Deploy your smart contract(s)\n\nRun the command below to deploy the smart contract to the target network. Make sure to have some funds in your deployer account to pay for the transaction.\n\n```\nyarn deploy --network network_name\n```\n\n4. Verify your smart contract\n\nYou can verify your smart contract on Etherscan by running:\n\n```\nyarn verify --network network_name\n```\n\n## Deploying your NextJS App\n\nRun `yarn vercel` and follow the steps to deploy to Vercel. Once you log in (email, github, etc), the default options should work. It'll give you a public URL.\n\nIf you want to redeploy to the same production URL you can run `yarn vercel --prod`. If you omit the `--prod` flag it will deploy it to a preview/test URL.\n\n**Make sure your `packages/nextjs/scaffold.config.ts` file has the values you need.**\n\n**Hint**: We recommend connecting the project GitHub repo to Vercel so you the gets automatically deployed when pushing to `main`\n\n## Disabling type and linting error checks\n\u003e **Hint**\n\u003e Typescript helps you catch errors at compile time, which can save time and improve code quality, but can be challenging for those who are new to the language or who are used to the more dynamic nature of JavaScript. Below are the steps to disable type \u0026 lint check at different levels\n\n### Disabling commit checks\nWe run `pre-commit` [git hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) which lints the staged files and don't let you commit if there is an linting error.\n\nTo disable this, go to `.husky/pre-commit` file and comment out `yarn lint-staged --verbose`\n\n```diff\n- yarn lint-staged --verbose\n+ # yarn lint-staged --verbose\n```\n\n### Deploying to Vercel without any checks\nVercel by default runs types and lint checks while developing `build` and deployment fails if there is a types or lint error.\n\nTo ignore types and lint error checks while deploying, use :\n```shell\nyarn vercel:yolo\n```\n\n### Disabling Github Workflow\nWe have github workflow setup checkout `.github/workflows/lint.yaml` which runs types and lint error checks every time code is __pushed__ to `main` branch or __pull request__ is made to `main` branch\n\nTo disable it, **delete `.github` directory**\n\n## Contributing to Scaffold-Eth 2\n\nWe welcome contributions to Scaffold-Eth 2!\n\nPlease see [CONTRIBUTING.MD](https://github.com/scaffold-eth/se-2/blob/master/CONTRIBUTING.md) for more information and guidelines for contributing to Scaffold-Eth 2.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faustintgriffith%2Fbglabs-streams","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faustintgriffith%2Fbglabs-streams","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faustintgriffith%2Fbglabs-streams/lists"}