An open API service indexing awesome lists of open source software.

https://github.com/smartcontractkit/smart-contract-examples

Example and sample projects
https://github.com/smartcontractkit/smart-contract-examples

Last synced: 29 days ago
JSON representation

Example and sample projects

Awesome Lists containing this project

README

        

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]




Smart Contract Examples and Samples


Report Bug
·
Request Feature


Table of Contents



  1. About The Project


  2. Getting Started


  3. Downloading A Single Directory


  4. Contributing

## About The Project

> **Important Notice**
> Please be aware that this repository contains reference and example contracts which may be **unaudited** and could include **hard-coded values**.
> Ensure that you review and audit any contracts before using them in production.

This repo contains example and sample projects, each in their own directory.

(back to top)

## Getting Started

Each directory within this repo will have a `README.md` that details everything you need to run the sample.

## Downloading A Single Directory

```sh
# Create a directory, and enter it
mkdir smart-contract-examples && cd smart-contract-examples

# Initialize a Git repository
git init

# Add this repository as a remote origin
git remote add -f origin https://github.com/smartcontractkit/smart-contract-examples/

# Enable the tree check feature
git config core.sparseCheckout true

# Create the spare-checkout file with the value
# the directory you wish to download
#
# Use the name of the directory as 'REPLACE_ME'
echo 'REPLACE_ME' >> .git/info/sparse-checkout

## Download with pull
git pull origin master
```

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/smartcontractkit/smart-contract-examples.svg?style=for-the-badge
[contributors-url]: https://github.com/smartcontractkit/smart-contract-examples/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/smartcontractkit/smart-contract-examples.svg?style=for-the-badge
[forks-url]: https://github.com/smartcontractkit/smart-contract-examples/network/members
[stars-shield]: https://img.shields.io/github/stars/smartcontractkit/smart-contract-examples.svg?style=for-the-badge
[stars-url]: https://github.com/smartcontractkit/smart-contract-examples/stargazers
[issues-shield]: https://img.shields.io/github/issues/smartcontractkit/smart-contract-examples.svg?style=for-the-badge
[issues-url]: https://github.com/smartcontractkit/smart-contract-examples/issues