{"id":13761767,"url":"https://github.com/nickytonline/web3-starter","last_synced_at":"2025-03-16T09:32:38.303Z","repository":{"id":40672353,"uuid":"412672603","full_name":"nickytonline/web3-starter","owner":"nickytonline","description":"An opinionated web3 starter for building dApps","archived":false,"fork":false,"pushed_at":"2023-01-07T22:06:52.000Z","size":2360,"stargazers_count":70,"open_issues_count":10,"forks_count":14,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-08-04T14:12:17.627Z","etag":null,"topics":["dapp","hacktoberfest","nextjs","react","solidity-contracts","solidity-dapps","typescript","web3"],"latest_commit_sha":null,"homepage":"https://the-web3-starter.vercel.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/nickytonline.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-10-02T02:47:36.000Z","updated_at":"2024-07-22T09:18:17.000Z","dependencies_parsed_at":"2023-02-08T02:32:56.894Z","dependency_job_id":null,"html_url":"https://github.com/nickytonline/web3-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickytonline%2Fweb3-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickytonline%2Fweb3-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickytonline%2Fweb3-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nickytonline%2Fweb3-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nickytonline","download_url":"https://codeload.github.com/nickytonline/web3-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221661528,"owners_count":16859536,"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":["dapp","hacktoberfest","nextjs","react","solidity-contracts","solidity-dapps","typescript","web3"],"created_at":"2024-08-03T14:00:27.825Z","updated_at":"2024-10-27T10:18:17.469Z","avatar_url":"https://github.com/nickytonline.png","language":"TypeScript","funding_links":[],"categories":["Nextjs Starter"],"sub_categories":[],"readme":"# Web3 Starter\n\nThe goal of this project is to give you an opinionated boilerplate to start a\nweb3 project.\n\n## Contributing\n\nIf you are interested in contributing to the project, first read our\n[contributing guidelines](./CONTRIBUTING.md). Take a look at our\n[existing issues](https://github.com/nickytonline/unofficial-edge-and-node-starter/issues),\nor if you come across an issue,\n[create an issue](https://github.com/nickytonline/unofficial-edge-and-node-starter/issues/new/choose).\nFor feature requests,\n[start a discussion](https://github.com/nickytonline/unofficial-edge-and-node-starter/discussions)\nfirst.\n\n## Getting Started (Local Development)\n\n1. Install the dependencies\n\n   ```bash\n   npm install\n   # or\n   yarn\n   ```\n\n1. Start the project\n\n   ```bash\n   npm run dev\n   # or\n   yarn dev\n   ```\n\nOpen [http://localhost:3000](http://localhost:3000) with your browser to see the\nresult.\n\n## Getting Started (Gitpod)\n\nThe project can be run in Gitpod. Navigate to\nhttps://gitpod.io/#https://github.com/nickytonline/hello-edge-and-node. If you\nwish to load it in Gitpod as an external contributor, you will need to fork the\nproject first, then open the fork in Gitpod, e.g.\nhttps://gitpod.io/#https://github.com/some_user_that_forked_the_repository/hello-edge-and-node.\n\n1. Gitpod will take a minute or two to load.\n1. If this is the first time loading the project in Gitpod, it will take longer\n   as all the npm packages are installing.\n1. The project wil start automatically in developer mode and the app will load\n   in the Gitpod preview window.\n\nFor move information on Gitpod, check out the\n[Gitpod documentation](https://www.gitpod.io/docs/).\n\n## Running tests\n\nThe project uses [jest](https://jestjs.io). For more information on jest, see\nthe [official documentation](https://jestjs.io/docs/getting-started).\n\nTo run tests:\n\n```bash\nnpm test\n# or\nyarn test\n```\n\nTo run tests in watch mode:\n\n```bash\nnpm test:watch\n# or\nyarn test:watch\n```\n\n## Building out components\n\nWhen building out components in the project, shared components can go in the\n`components` folder. Components can then be imported using the `@components`\nalias, e.g. `import { ExampleHeader } from '@components/Header';`.\n\n### Storybook\n\nThe project uses [Storybook](https://storybook.js.org) for building our\ncomponents. For more on Storybook, see the\n[official documentation](https://storybook.js.org/docs/react).\n\n### Running Storybook\n\n```bash\nnpm run storybook\n# or\nyarn storybook\n```\n\n### Building Storybook Static Site\n\n```bash\nnpm run build-storybook\n# or\nyarn build-storybook\n```\n\n## Under the hood\n\n### Basic Sample Hardhat Project\n\nThis project demonstrates a basic Hardhat use case. It comes with a sample\ncontract, a test for that contract, a sample script that deploys that contract,\nand an example of a task implementation, which simply lists the available\naccounts.\n\nTry running some of the following tasks:\n\n```shell\nnpx hardhat accounts\nnpx hardhat compile\nnpx hardhat clean\nnpx hardhat test\nnpx hardhat node\nnode scripts/sample-script.js\nnpx hardhat help\n```\n\nUnlike jest, tests for Hardhat are located in the `/test` folder and use\nmocha/chai.\n\nFor more on Hardhat, see the\n[official documentation](https://hardhat.org/getting-started/).\n\n### Next.js\n\nThis is a [Next.js](https://nextjs.org/) project bootstrapped with\n[`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).\n\nYou can start editing the page by modifying `pages/index.tsx`. The page\nauto-updates as you edit the file.\n\n[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on\n[http://localhost:3000/api/hello](http://localhost:3000/api/hello). This\nendpoint can be edited in `pages/api/hello.ts`.\n\nThe `pages/api` directory is mapped to `/api/*`. Files in this directory are\ntreated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead\nof React pages.\n\nTo learn more about Next.js, take a look at the following resources:\n\n- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js\n  features and API.\n- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.\n\nYou can check out\n[the Next.js GitHub repository](https://github.com/vercel/next.js/) - your\nfeedback and contributions are welcome!\n\n### Apollo\n\nFor more on Apollo, check out their\n[official documentation](http://apollographql.com/docsd).\n\n### Ethers.js\n\nFor more on Ethers.js, check out their\n[official documentation](https://docs.ethers.io/).\n\n### Theme UI\n\nFor more on theme UI, check out their\n[official documentation](https://theme-ui.com/getting-started).\n\n## Deploy on Vercel\n\nThe easiest way to deploy your Next.js app is to use the\n[Vercel Platform](https://vercel.com/new?utm_medium=default-template\u0026filter=next.js\u0026utm_source=create-next-app\u0026utm_campaign=create-next-app-readme)\nfrom the creators of Next.js.\n\nCheck out our\n[Next.js deployment documentation](https://nextjs.org/docs/deployment) for more\ndetails.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickytonline%2Fweb3-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnickytonline%2Fweb3-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickytonline%2Fweb3-starter/lists"}