{"id":13620748,"url":"https://github.com/Shimmi/smart-contracts-skeleton","last_synced_at":"2025-04-14T22:32:21.793Z","repository":{"id":79050613,"uuid":"118892221","full_name":"Shimmi/smart-contracts-skeleton","owner":"Shimmi","description":"Repository skeleton to help you build or start with the development of Smart contracts for Ethereum blockchain written in Solidity language.","archived":false,"fork":false,"pushed_at":"2018-01-29T14:07:58.000Z","size":78,"stargazers_count":23,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-10T22:34:58.048Z","etag":null,"topics":["blockchain","ethereum","skeleton","smart-contract-tools","smart-contracts","solidity","truffle"],"latest_commit_sha":null,"homepage":"","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/Shimmi.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-01-25T09:31:35.000Z","updated_at":"2023-02-03T09:06:03.000Z","dependencies_parsed_at":null,"dependency_job_id":"9fd5362f-1e22-4ee9-9c4a-537673b07623","html_url":"https://github.com/Shimmi/smart-contracts-skeleton","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Shimmi%2Fsmart-contracts-skeleton","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Shimmi%2Fsmart-contracts-skeleton/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Shimmi%2Fsmart-contracts-skeleton/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Shimmi%2Fsmart-contracts-skeleton/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Shimmi","download_url":"https://codeload.github.com/Shimmi/smart-contracts-skeleton/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248972146,"owners_count":21191732,"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":["blockchain","ethereum","skeleton","smart-contract-tools","smart-contracts","solidity","truffle"],"created_at":"2024-08-01T21:00:59.068Z","updated_at":"2025-04-14T22:32:21.787Z","avatar_url":"https://github.com/Shimmi.png","language":"JavaScript","funding_links":[],"categories":["Libraries"],"sub_categories":[],"readme":"# Skeleton for Ethereum Smart Contracts\n_Jump start your Smart Contracts development with no configuration._\n\nThis skeleton repository gives you a good foundation for building or starting with the development of Smart contracts for Ethereum blockchain written in Solidity language.\n\n## Quickstart\n1. Clone this repo.\n2. Run `npm install`.\n\nThat's all!\n\n## What’s Included?\n\n* **[Truffle framework](http://truffleframework.com/)**: The most popular development framework for Ethereum.\n* **[OpenZeppelin](https://openzeppelin.org/)**: Framework of reusable and secure smart contracts in the Solidity language.\n* **[Solium](https://github.com/duaraghav8/Solium)**: Linter to identify and fix style \u0026 security issues in Solidity.\n* **[Solidity Coverage](https://github.com/sc-forks/solidity-coverage)**: Code coverage for Solidity testing.\n* **[Babel](https://babeljs.io/)**: Compiler for next-generation Javascript.\n* **[Mocha](http://mochajs.org/)**: Javascript testing framework.\n* **[Chai](http://chaijs.com/)**: Javascript BDD/TDD assertion library.\n\n## Requirements\nThe only (base) requirement is **Node with NPX**.\n\n_**Note**_: If you are developing on Windows the \"Bash on Linux on Windows\" is highly recommended for running code coverage. If you want to run it directly in Powershell/cmd, follow [this guide](https://github.com/sc-forks/solidity-coverage/blob/master/docs/faq.md#running-on-windows) (Not recommended).\n\n_([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) is bundled with npm 5.2+ and higher.)_\n\n## Usage\n\n### Testing\nTests are located in `test/` folder and are mostly written in javascript. This skeleton gives you preconfigured support for ES2015+ features. Thanks to the new `import`, `async`/`await` and arrow functions the tests are much cleaner and simpler.\n\nSee the [Mocha](http://mochajs.org/) and [Chai](http://chaijs.com/) documentation for writing tests.\n\n```bash\nnpm test\n```\n\n### Compiling\nThe contracts are compiled automatically when running the commands (e.g. `npm test`, `npm run migrate`, ..). Yet it can be handy to run the compilation manually as then the files are persisted and not deleted on command exit.\n \nRunning the compile method will generate a `build/` folder with JSON files containing the contracts bytecode, source map, [abi](https://solidity.readthedocs.io/en/develop/abi-spec.html) and more. This can speed up running the tests as it will not recompile them on every run (unless changing the contracts code).\n```bash\nnpm run compile\n```\n\n### Generating code coverage\nRunning the code coverage command will generate a `coverage/` folder. Open the `index.html` to view the results.\n\n```bash\nnpm run coverage\n```\n\n### Linting the code\nLinting will statically analyze your code to identify style \u0026 security issues.\n\n```bash\nnpm run lint\n```\n\n### Migrating to the network\nTo publish and interact with your contracts, you will need to \"migrate\" them.\n\nThis changes and may need a bit of configuration depending to which network and/or RPC you are deploying.\n\nPlease see Truffle's [Ganache](http://truffleframework.com/ganache/) or Geth's `geth --dev` [command](https://github.com/ethereumproject/go-ethereum/wiki/Command-Line-Options) for running personal developer blockchain.\n\n```bash\nnpm run migrate\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FShimmi%2Fsmart-contracts-skeleton","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FShimmi%2Fsmart-contracts-skeleton","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FShimmi%2Fsmart-contracts-skeleton/lists"}