{"id":19147863,"url":"https://github.com/refcell/cairo-by-example","last_synced_at":"2025-05-07T03:05:36.372Z","repository":{"id":43332787,"uuid":"440567316","full_name":"refcell/cairo-by-example","owner":"refcell","description":"Verbosely Documented, Minimal Starknet Contract Examples.","archived":false,"fork":false,"pushed_at":"2022-03-07T19:54:24.000Z","size":735,"stargazers_count":66,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-17T20:18:30.200Z","etag":null,"topics":["cairo","chakra-ui","nextjs","starknet","starkware","typescript"],"latest_commit_sha":null,"homepage":"https://cairo-by-example.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/refcell.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":"2021-12-21T15:39:58.000Z","updated_at":"2024-03-20T07:18:32.000Z","dependencies_parsed_at":"2022-09-03T04:51:51.759Z","dependency_job_id":null,"html_url":"https://github.com/refcell/cairo-by-example","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/refcell%2Fcairo-by-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/refcell%2Fcairo-by-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/refcell%2Fcairo-by-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/refcell%2Fcairo-by-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/refcell","download_url":"https://codeload.github.com/refcell/cairo-by-example/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223801047,"owners_count":17205009,"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":["cairo","chakra-ui","nextjs","starknet","starkware","typescript"],"created_at":"2024-11-09T07:52:35.480Z","updated_at":"2024-11-09T07:52:35.963Z","avatar_url":"https://github.com/refcell.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cairo-by-example • [![tests \u0026 lints](https://github.com/a5f9t4/cairo-by-example/actions/workflows/ci.yml/badge.svg)](https://github.com/a5f9t4/cairo-by-example/actions/workflows/ci.yml) ![GitHub](https://img.shields.io/github/license/a5f9t4/cairo-by-example) ![GitHub package.json version](https://img.shields.io/github/package-json/v/a5f9t4/cairo-by-example) ![Vercel Deployment](https://img.shields.io/github/deployments/a5f9t4/cairo-by-example/production?label=vercel)\n\n**Verbosely** Documented, **Minimal** Starknet Contract Examples.\n\n**Cairo By Example** deployed to [https://cairo-by-example.xyz](https://cairo-by-example.xyz)\n\n## Developing\n\nClone the repository\n\n```bash\ngit clone git@github.com:a5f9t4/cairo-by-example.git\ncd cairo-by-example\n```\n\nInstall Dependencies\n\n```bash\nyarn\n```\n\nRun locally\n\n```bash\nyarn dev\n```\n\n## Contracts\n\nContracts are defined and available for extensible use in the [contracts](https://github.com/a5f9t4/cairo-by-example/tree/main/contracts) subdirectory.\n\n### Usage\n\n#### First time?\n\nFurther installation instructions provided in the [cairo-lang docs](https://www.cairo-lang.org/docs/quickstart.html)\n\nBefore installing Cairo on your machine, you need to install `gmp`:\n```bash\nsudo apt install -y libgmp3-dev # linux\nbrew install gmp # mac\n```\n\u003e If you have any troubles installing gmp on your Apple M1 computer, [here’s a list of potential solutions](https://github.com/OpenZeppelin/nile/issues/22).\n\nFor VSCode support:\n\nDownload `cairo-0.6.2.vsix` from https://github.com/starkware-libs/cairo-lang/releases/tag/v0.6.2\n\nAnd run:\n```bash\ncode --install-extension cairo-0.6.2.vsix\n```\n\n#### Set up the environment\n\n\n`cd` into it and create a Python virtual environment:\n\n```bash\npython3 -m venv env\nsource env/bin/activate\n```\n\n#### Nile\n\nInstall the [Nile](https://github.com/OpenZeppelin/nile) dev environment and then run `install` to get [the Cairo language](https://www.cairo-lang.org/docs/quickstart.html), a [local network](https://github.com/Shard-Labs/starknet-devnet/), and a [testing framework](https://docs.pytest.org/en/6.2.x/).\n```bash\npip3 install cairo-nile\nnile install\n```\n\n\n#### Compile the contracts\n\n```bash\nnile compile\n```\n\n#### Run tests\n\n```bash\npytest\n```\n\n## Acknowledgements\n\n- [Perama's Notes](https://perama-v.github.io/cairo/by-example/)\n\n## Security\n\nThis project is still in a very early and experimental phase. It has never been audited nor thoroughly reviewed for security vulnerabilities. Not recommended for production use.\n\nPlease report any security issues you find by opening up an issue in this reposisitory.\n\n## License\n\nCairo-by-example Contracts are released under the [AGPL-3.0-only](LICENSE).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frefcell%2Fcairo-by-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frefcell%2Fcairo-by-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frefcell%2Fcairo-by-example/lists"}