The nOS Client
Branch: develop
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci chore(circleci): update config (#817) Jan 12, 2019
.github chore(docs): removed docs and updated readme accordingly (#316) Jul 22, 2018
__mocks__ feat(menu) open tab, open location, close tab, & shortcut keys (#595) Sep 30, 2018
__tests__ feat(account): loading state (#748) Feb 11, 2019
config Update css-loader to the latest version 🚀 (#307) Sep 4, 2018
src chore(networks): fix network issue (#880) Feb 15, 2019
static chore(autoUpdates): check for updates during splashscreen and added u… Jan 24, 2019
.babelrc feat(block): poll for latest block (#521) Sep 12, 2018
.codecov.yml chore(forms): forward component refs to DOM elements (#412) Aug 26, 2018
.env Added sass modules via custom-react-scripts Feb 15, 2018
.eslintignore feat(build): replace react-scripts with electron-webpack (#243) Jun 18, 2018
.eslintrc.json chore(main): refactor util functions (#366) Jul 29, 2018
.gitignore chore(autoUpdate): disable update check in dev mode (#854) Jan 26, 2019
.stylelintrc
.yarnrc feat(src): added auto-updater (#782) Jan 12, 2019
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Apr 25, 2018
LICENSE Create LICENSE Apr 25, 2018
README.md chore(readme): update readme for new release process (#851) Jan 24, 2019
dev-app-update.yml chore(autoUpdate): disable update check in dev mode (#854) Jan 26, 2019
package.json chore(deps): update lint (#883) Feb 19, 2019
renovate.json feat(src): added auto-updater (#782) Jan 12, 2019
yarn.lock chore(deps): update lint (#883) Feb 19, 2019

README.md

nOS

nOS is a blockchain powered virtual operating system that serves as the gateway to Decentralized Applications.

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


Getting Started with nOS

The standalone client installers can be found here. To build manually, the client can be cloned from GitHub and run using the development steps below.

Commands

# Cloning from Github
git clone https://github.com/nos/client.git

# 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

# Testing with debug (repl) command
yarn test:debug

# Distribution command (code signing certificates are required to make this work)
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:

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

Contribute by building a dApp on nOS

Need some help with building nOS dApps? Check out our dedicated documentation website containing useful info for the following topics:

Check out the documentation of the Create nOS dApp CLI tool to get going quickly.

Resources:

Releasing

Windows & Linux

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

  1. Create a tag, e.g. v1.0.0.
    1. git tag -a v1.0.0 -m "release" - the v-prefix is required for auto updates to work
    2. git push origin v1.0.0
  2. Wait for deploy_win64 and deploy_linux jobs to upload the artifacts to Github Release page as a draft.

macOS

  1. Export the following variables:
    1. CSC_LINK - This is the path to the .p12 certificate file
    2. CSC_KEY_PASSWORD - This is the password of the .p12 certificate file
    3. CSC_IDENTITY_AUTO_DISCOVERY - Set to false to disable usage of local keychain (By default it looks in your login keychain)
  2. Create the distributable, i.e. yarn dist.
  3. Locate and upload the following files as these are required for the auto-updater to work:
    1. dist/nOS-1.0.0-mac.zip
    2. dist/nOS-1.0.0-mac.dmg
    3. dist/nOS-1.0.0-mac.dmg.blockmap
    4. dist/latest-mac.yml