installation.md

---
sidebar_position: 2
---

# Installation

## Prerequisite

1. Install `Node.js` and `NPM` on your machine by following the instructions over [here](https://nodejs.org/en/download).

:::note
Require `Node.js` version `>=16`.
:::

2. Install [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).

## The sCrypt CLI Tool

The [sCrypt CLI tool](https://github.com/sCrypt-Inc/scrypt-cli) is used to easily create, compile and publish `sCrypt` projects. The CLI provides best practice project scaffolding including dependencies such as sCrypt, a test framework ([Mocha](https://mochajs.org)), code auto-formatting ([Prettier](https://prettier.io)), linting ([ES Lint](https://eslint.org)), & more.

Install it and try it out by creating a demo project:
```sh
npm install -g scrypt-cli
scrypt project demo
```

:::tip
You can also simply fork [the demo contract Repl](https://replit.com/@msinkec/scryptTS-demo) and play with the code in your browser.
:::