nOS

nOS is a NEO-powered virtual operating system that serves as the gateway to the NEO Smart Economy.

The nOS Client (Developer MVP Release) allows for the development of Decentralized Applications that interact with NEO Smart Contracts in the back-end.

---

Getting Started with nOS

The app can be cloned from GitHub and run using the development steps below.

nOS Client Developer Documentation

• API Documentation
• Create your own dApp
• Setup nos-local

Commands

// Install dependencies and launch the nOS client
// This is used to start developing on the nOS client
yarn install && yarn start

// Testing command
yarn test

// Distribution command
yarn dist

Contribute to this repository

We welcome contributions to the code base. If you are interested in becoming a contributor, please read the contributing guide that covers the following:

• Reporting bugs
• Suggesting enchancements
• Code contribution guidelines

There is a specific channel called develop on Discord to discuss development.

Contribute by building a dApp on nOS

Check out the documentation of the dapp-starter-kit dApp-starter-kit to get going quickly.

Resources:

• dApp-starter-kit repository
• dApp-starter-kit example (NeoBlog implementation)

Future resources:

• Tutorials (Feel free to create any tutorials!!)
• List of known bugs
• List of coming features

Releasing

Windows & Linux

We use CircleCI to automatically create builds based upon git tags.

1. Create a tag, e.g. 1.0.0. a. git tag -a 1.0.0 b. git push origin 1.0.0
2. Wait for deploy_win64 and deploy_linux jobs to finish on CircleCI.
3. Open "Artifacts" tab & download executable files.

macOS

nOS currently requires a system running macOS.

1. Create the distributable, i.e. yarn dist.
2. Locate executable file dist/nOS-1.0.0.dmg.