{"id":18263771,"url":"https://github.com/yearn/web-template","last_synced_at":"2025-04-04T20:31:18.854Z","repository":{"id":37072902,"uuid":"452861309","full_name":"yearn/web-template","owner":"yearn","description":"Template for the next projects from Yearn.Finance","archived":false,"fork":false,"pushed_at":"2023-09-03T16:22:43.000Z","size":2476,"stargazers_count":8,"open_issues_count":3,"forks_count":13,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-20T19:07:23.043Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://web.ycorpo.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yearn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-27T22:10:01.000Z","updated_at":"2024-02-07T04:02:45.000Z","dependencies_parsed_at":"2024-11-05T11:15:08.667Z","dependency_job_id":"c7a267b7-f125-4df5-8394-0e5a695ad9de","html_url":"https://github.com/yearn/web-template","commit_stats":null,"previous_names":[],"tags_count":1,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yearn%2Fweb-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yearn%2Fweb-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yearn%2Fweb-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yearn%2Fweb-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yearn","download_url":"https://codeload.github.com/yearn/web-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247246367,"owners_count":20907782,"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-11-05T11:12:34.595Z","updated_at":"2025-04-04T20:31:17.279Z","avatar_url":"https://github.com/yearn.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Yearn Web Lib\n![](./public/og.jpeg)\n\nThe Yearn Web Template provides an easy way to bootstrap a new Yearn Web project.  \nThis include the default repo structure and configurations with the latest dependencies and compatible web-lib version.  \n\nThe stack used for this project is the following:\n- 💙 [Yearn Web Lib](https://github.com/yearn/web-lib) — Base for our web-lib\n- 🚀 [Next](https://nextjs.org) — JavaScript library for user interfaces\n- ▲ [Vercel](https://vercel.com) — Cloud deployment platform\n- 📄 [TypeScript](https://www.typescriptlang.org/) for static type checking\n- 💄 [ESLint](https://eslint.org/) for code linting\n\n### Install and run\n1. Clone as template from GitHub\n2. Run `yarn`\n3. Run `yarn run dev`\n4. Open the browser and navigate to `http://localhost:3000`\n\n\n### Usage\n\n##### Meta tags and Meta Data\nYou can update the `public/manifest.json` file which will be use to handle the meta tags and for the Gnosis wallet support:\n- Update `name` with your project name\n- Update `description` with your project description\n- Update `iconPath` with the relative path to your SVG icon (ideally, it should stay as is)\n- Update `locale` for the default language of your project\n- Update `uri` with the base path of your project.\n- Update `og` with the path to your OG image.\n- Update `twitter` with your twitter handle\n- Update `github` with your project GitHub link.\n\nMore options are available in the `public/manifest.json` file.\n\n##### IPFS deployement\nBy default, IPFS auto deployments are disabled. You can enable the workflow by editing the `.github/workflows/ipfs.yml` file, un-commenting lines 5-6, enabling an IPFS deployment each time a push occurs on the `main` branch.  \nOtherwise, you can go in actions and run the `ipfs` action.  \nTwo environment variables are required to make it work, which are configurable in your Github Project Secret Variables:\n- `IPFS_HOST`: the host of the IPFS node\n- `IPFS_PORT`: the port of the IPFS node\n\n##### Run with Docker\nThis project can be run with Docker.\n1. Build the image: `docker build -t [name-of-your-container] .`\n2. Run the container: `docker run -p 3000:3000 [name-of-your-container]`\n3. Open the browser and navigate to `http://localhost:3000`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyearn%2Fweb-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyearn%2Fweb-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyearn%2Fweb-template/lists"}