{"id":18953156,"url":"https://github.com/0xpolygon/foundry-template","last_synced_at":"2025-04-16T02:32:00.596Z","repository":{"id":210074019,"uuid":"708823792","full_name":"0xPolygon/foundry-template","owner":"0xPolygon","description":"Contracts team, template repo","archived":false,"fork":false,"pushed_at":"2024-03-13T13:33:32.000Z","size":163,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-03-13T14:48:21.189Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Solidity","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/0xPolygon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE-APACHE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-10-23T13:16:26.000Z","updated_at":"2024-02-06T11:51:29.000Z","dependencies_parsed_at":"2024-01-30T12:43:29.405Z","dependency_job_id":"a45f5dea-dab7-4470-814c-5cba457e0097","html_url":"https://github.com/0xPolygon/foundry-template","commit_stats":null,"previous_names":["0xpolygon/foundry-template"],"tags_count":2,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xPolygon%2Ffoundry-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xPolygon%2Ffoundry-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xPolygon%2Ffoundry-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0xPolygon%2Ffoundry-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/0xPolygon","download_url":"https://codeload.github.com/0xPolygon/foundry-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223692701,"owners_count":17187064,"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-08T13:36:52.717Z","updated_at":"2024-11-08T13:36:53.398Z","avatar_url":"https://github.com/0xPolygon.png","language":"Solidity","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Template Repo (Foundry)\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![CI Status](../../actions/workflows/test.yaml/badge.svg)](../../actions)\n\nThis template repo is a quick and easy way to get started with a new Solidity project. It comes with a number of features that are useful for developing and deploying smart contracts. Such as:\n\n- Pre-commit hooks for formatting, auto generated documentation, and more\n- Various libraries with useful contracts (OpenZeppelin, Solady) and libraries (Deployment log generation, storage checks, deployer templates)\n\n#### Table of Contents\n\n- [Setup](#setup)\n- [Deployment](#deployment)\n- [Docs](#docs)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Setup\n\nFollow these steps to set up your local environment:\n\n- [Install foundry](https://book.getfoundry.sh/getting-started/installation)\n- Install dependencies: `forge install`\n- Build contracts: `forge build`\n- Test contracts: `forge test`\n\nIf you intend to develop on this repo, follow the steps outlined in [CONTRIBUTING.md](CONTRIBUTING.md#install).\n\n## Deployment\n\nThis repo utilizes versioned deployments. For more information on how to use forge scripts within the repo, check [here](CONTRIBUTING.md#deployment).\n\nSmart contracts are deployed or upgraded using the following command:\n\n```shell\nforge script script/Deploy.s.sol --broadcast --rpc-url \u003crpc_url\u003e --verify\n```\n\n## Docs\n\nThe documentation and architecture diagrams for the contracts within this repo can be found [here](docs/).\nDetailed documentation generated from the NatSpec documentation of the contracts can be found [here](docs/autogen/src/src/).\nWhen exploring the contracts within this repository, it is recommended to start with the interfaces first and then move on to the implementation as outlined [here](CONTRIBUTING.md#natspec--comments)\n\n## Contributing\n\nIf you want to contribute to this project, please check [CONTRIBUTING.md](CONTRIBUTING.md) first.\n\n## License\n\n​\nLicensed under either of\n​\n\n- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)\n- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)\n  ​\n\nat your option.\n\nUnless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.\n\n---\n\n© 2023 PT Services DMCC\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0xpolygon%2Ffoundry-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F0xpolygon%2Ffoundry-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0xpolygon%2Ffoundry-template/lists"}