{"id":18011772,"url":"https://github.com/vittominacori/solidity-starter-kit","last_synced_at":"2025-03-26T16:30:50.763Z","repository":{"id":56187440,"uuid":"165737030","full_name":"vittominacori/solidity-starter-kit","owner":"vittominacori","description":"A starter kit for Ethereum Smart Contracts development","archived":false,"fork":false,"pushed_at":"2023-05-24T08:58:23.000Z","size":2481,"stargazers_count":26,"open_issues_count":0,"forks_count":13,"subscribers_count":2,"default_branch":"master","last_synced_at":"2023-05-24T09:33:36.750Z","etag":null,"topics":["ethereum","hardhat","openzeppelin","smart-contracts","solidity","truffle"],"latest_commit_sha":null,"homepage":"https://vittominacori.github.io/solidity-starter-kit/","language":"JavaScript","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/vittominacori.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-01-14T21:20:43.000Z","updated_at":"2023-05-24T08:58:28.000Z","dependencies_parsed_at":"2022-08-15T14:20:25.242Z","dependency_job_id":null,"html_url":"https://github.com/vittominacori/solidity-starter-kit","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vittominacori%2Fsolidity-starter-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vittominacori%2Fsolidity-starter-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vittominacori%2Fsolidity-starter-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vittominacori%2Fsolidity-starter-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vittominacori","download_url":"https://codeload.github.com/vittominacori/solidity-starter-kit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222155951,"owners_count":16940424,"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":["ethereum","hardhat","openzeppelin","smart-contracts","solidity","truffle"],"created_at":"2024-10-30T03:12:48.068Z","updated_at":"2024-10-30T03:12:48.571Z","avatar_url":"https://github.com/vittominacori.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\ntitle: Easily build your smart contracts\n---\n\n# Solidity Starter Kit\n\n[![CI](https://github.com/vittominacori/solidity-starter-kit/workflows/CI/badge.svg?branch=master)](https://github.com/vittominacori/solidity-starter-kit/actions/)\n[![Coverage Status](https://coveralls.io/repos/github/vittominacori/solidity-starter-kit/badge.svg)](https://coveralls.io/github/vittominacori/solidity-starter-kit)\n[![MIT licensed](https://img.shields.io/github/license/vittominacori/solidity-starter-kit.svg)](https://github.com/vittominacori/solidity-starter-kit/blob/master/LICENSE)\n\n\nA starter kit for Ethereum Smart Contracts development\n\n\u003e :warning: **NOTE**: This repository is no longer updated. Please use [Solidity Toolkit](https://github.com/noncept/solidity-toolkit).\n\n\n## Development\n\n### Install dependencies\n\n```bash\nnpm install\n```\n\n## Usage (using Truffle)\n\nOpen the Truffle console\n\n```bash\nnpm run truffle:console\n```\n\n### Compile\n\n```bash\nnpm run truffle:compile\n```\n\n### Test\n\n```bash\nnpm run truffle:test\n```\n\n## Usage (using Hardhat)\n\nOpen the Hardhat console\n\n```bash\nnpm run hardhat:console\n```\n\n### Compile\n\n```bash\nnpm run hardhat:compile\n```\n\n### Test\n\n```bash\nnpm run hardhat:test\n```\n\n### Code Coverage\n\n```bash\nnpm run hardhat:coverage\n```\n\n## Linter\n\nUse Solhint\n\n```bash\nnpm run lint:sol\n```\n\nUse ESLint\n\n```bash\nnpm run lint:js\n```\n\nUse ESLint and fix\n\n```bash\nnpm run lint:fix\n```\n\n## Use web3 console in your browser (i.e. to use MetaMask)\n\nBy default it takes contracts compiled with Truffle.\n\nTo use Hardhat compiled contracts change `./build/contracts` with `./artifacts` in `bs-config.json`\n\n```bash\nnpm run dev\n```\n\n## Flattener\n\nThis allow to flatten the code into a single file\n\nEdit `scripts/flat.sh` to add your contracts\n\n```bash\nnpm run flat\n```\n\n## Analysis\n\nNote: it is better to analyze the flattened code to have a bigger overview on the entire codebase. So run the flattener first.\n\n### Describe\n\nThe `describe` command shows a summary of the contracts and methods in the files provided\n\n```bash\nsurya describe dist/SampleContract.dist.sol\n```\n\n### Dependencies\n\nThe `dependencies` command outputs the c3-linearization of a given contract's inheirtance graph. Contracts will be listed starting with most-derived, ie. if the same function is defined in more than one contract, the solidity compiler will use the definition in whichever contract is listed first.\n\n```bash\nsurya dependencies SampleContract dist/SampleContract.dist.sol\n```\n### Generate Report\n\nEdit `scripts/analyze.sh` to add your contracts\n\n```bash\nnpm run analyze\n```\n\nThe `inheritance` command outputs a DOT-formatted graph of the inheritance tree.\n\nThe `graph` command outputs a DOT-formatted graph of the control flow.\n\nThe `mdreport` command creates a markdown description report with tables comprising information about the system's files, contracts and their functions.\n\nThe `sol2uml` generates UML class diagram from Solidity contracts.\n\n## License\n\nCode released under the [MIT License](https://github.com/vittominacori/solidity-starter-kit/blob/master/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvittominacori%2Fsolidity-starter-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvittominacori%2Fsolidity-starter-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvittominacori%2Fsolidity-starter-kit/lists"}