Quick Start Guide

Get up and running with Neo Service Layer in minutes. This guide will walk you through the installation process and help you deploy your first smart contract.

Prerequisites

System Requirements

  • .NET 8.0 SDK or later
  • Neo CLI or Neo Express
  • Visual Studio Code (recommended)
  • Git for version control

Installation

1

Clone the Repository

Start by cloning the Neo Service Layer repository to your local machine.

Terminal 
git clone https://github.com/neo-project/neo-service-layer.git
cd neo-service-layer
2

Install Dependencies

Restore the required NuGet packages and build the solution.

Terminal 
dotnet restore
dotnet build
3

Run Tests

Verify your installation by running the test suite.

Terminal 
./scripts/testing/run-all-tests.sh
4

Deploy Your First Contract

Deploy a sample contract to test your setup.

Terminal 
cd src/contracts/UserManagementContract
dotnet build
neo-express contract deploy bin/sc/UserManagementContract.nef

Next Steps

API Reference

Explore the complete API documentation for all available services.

View API Docs

Examples

Learn from practical examples and implementation patterns.

View Examples

Advanced Setup

Configure advanced features and deployment options.

Advanced Guide

Need Help?

If you encounter any issues during setup, check out our troubleshooting guide or reach out to the community.

Report Issue Join Discord