Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/OpenZeppelin/nile

CLI tool to develop StarkNet projects written in Cairo
https://github.com/OpenZeppelin/nile

Last synced: 3 months ago
JSON representation

CLI tool to develop StarkNet projects written in Cairo

Host: GitHub
URL: https://github.com/OpenZeppelin/nile
Owner: OpenZeppelin
License: mit
Archived: true
Created: 2021-09-19T22:05:19.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2023-12-01T15:24:28.000Z (11 months ago)
Last Synced: 2024-07-09T04:05:15.670Z (4 months ago)
Language: Python
Homepage:
Size: 1020 KB
Stars: 322
Watchers: 9
Forks: 76
Open Issues: 60
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

best-of-crypto - GitHub - 29% open · ⏱️ 01.12.2023): (Smart Contract Platforms)

README

        > Disclaimer: this project is deprecated and no longer maintained. Check out [scarb](https://docs.swmansion.com/scarb/) instead.

# OpenZeppelin | Nile ⛵

[![Docs](https://img.shields.io/badge/docs-%F0%9F%93%84-blue)](https://docs.openzeppelin.com/nile)

[![Tests and linter](https://github.com/OpenZeppelin/nile/actions/workflows/ci.yml/badge.svg)](https://github.com/OpenZeppelin/nile/actions/workflows/ci.yml)

> _Navigate your [StarkNet](https://www.cairo-lang.org/docs/hello_starknet/index.html) projects written in [Cairo](https://cairo-lang.org)._

## Overview

Nile is a CLI tool to develop or interact with StarkNet projects written in Cairo. It consists of different components for developing, compiling, testing, and deploying your smart contracts and dApps, providing a CLI for executing tasks, and a Runtime Environment (NRE) for scripting. The package is designed to be extensible and very customizable by using plugins.

## Documentation

On our [documentation site](https://docs.openzeppelin.com/nile) you can find:

- [A Quickstart walkthrough with commands examples](https://docs.openzeppelin.com/nile#quickstart)

- [Guides on how to master development with Nile](https://docs.openzeppelin.com/nile/testing)

- [Useful script examples](https://docs.openzeppelin.com/nile/scripts#useful_script_examples)

- [Plugins](https://docs.openzeppelin.com/nile/plugins)

And more.

## Installation

Current supported Python versions are >=3.9 and <3.10.

1. Install `gmp` on your machine (Cairo requirement).

    ```

    sudo apt install -y libgmp3-dev # linux

    or

    brew install gmp # mac

    ```

    If you have any trouble installing it on your Apple M1 computer, [here’s a list of potential solutions.](https://github.com/OpenZeppelin/nile/issues/22)

2. Create a folder for your project and cd into it:

    ```

    mkdir myproject && cd myproject

    ```

3. Create a virtualenv and activate it:

    ```

    python3 -m venv env && source env/bin/activate

    ```

4. Install Nile:

    ```

    pip install cairo-nile

    ```

## Quickstart

Use `nile init` to quickly set up your development environment:

```

nile init

```

```

🗄 Creating project directory tree

⛵️ Nile project ready! Try running:

nile compile

```

## Contribute

OpenZeppelin Nile exists thanks to its contributors. There are many ways you can participate and help build high quality software. Check out the [contribution](CONTRIBUTING.md) guide!

## License

Nile is released under the MIT License.