The instructions below are for developers building on Linux. We have separate installation instructions for Mac users and Windows users.
Requirements:
sudo apt-get update
sudo apt-get install g++ make git python-is-python3 npm
curl -sL https://deb.nodesource.com/setup_16.x | sudo -E bash
sudo apt-get install -y nodejs
The following instructions should be similar for Mac, Windows and the broader audience of Linux users; if you are not using Ubuntu, substitute in your package manager where appropriate.
git clone https://github.com/saitotech/saito-lite-rust
cd saito-lite-rust
npm install
Note: If npm fails to install a module, you may need to install python-is-python3.
On Ubuntu:
sudo apt-get install python-is-python3
npm run nuke
npm start
If after a few moments with no errors a large Saito ASCII Logo appears on screen, move on to the next step.
It is common that errors at this stage are related to your NodeJS install, so consider first searching for NodeJS troubleshooting help if you can't get Saito running at this stage.
Once you have run npm start it will take a few moments for the Saito software to initialize and start. You will eventually see an animated Saito logo scroll across your terminal. Once that is done simply open a browser and visit:
To visit your Saito instance on your VPS:
http://<your_server_ip>:12101
Any changes can be compiled with npm run nuke. The final compiled file will rest in config/options.
Visit the deploy instructions to learn how to connect your Saito Node to the public internet.
Applications like the Saito Arcade run inside the Saito Wallet, which receives on-chain and off-chain messages and passes them into the modules that are running inside the user wallet. If you want to get started building applications, we recommend starting with our tutorial series for new Application Developers.
Once you have installed Saito-Lite-Rust you will be ready to configure the server to run the applications you wish to support and provide them to browsers on-demand. This section covers these follow-on configuration steps.
Saito uses two main configuration files. The first is config/options which specifies network configuration options like the IP address on which the server runs and the ports it should open and the peers to which it should connect. A second config/modules.config.js file specifies which modules should run on the server and any browsers that connect to it.
Running npm run nuke will create fresh versions of these configuration files from template files that are stored in the config directory. It will also compiles a compressed version of Saito from the modules.config.js that will be fed out to browsers which connect to the server and request the default javascript.
You can always reset your client by running the "nuke" command, but if you wish to change the applications supported on your server without resetting the blockchain, you can run the following instruction instead:
npm run compile
compile ScriptThe compile script supports additional logging options, which can be specified using the --loglevel or -l flags. This feature allows you to set the desired log level for the compilation process.
To set a specific log level, use one of the following commands:
npm run compile -- --loglevel=<level>
or
npm run compile -- -l <level>
Where level can be one of the following:
npm run compile -- --loglevel=warn
or
npm run compile -- -l warn
Both the compile and nuke scripts can be run with a dev flag:
npm run compile dev
npm run nuke dev
When this flag is used:
JavaScript is not minimized and source maps are shipped with the code
The payload is 2 to 3 times larger than otherwise but makes in-browser
debugging possible.
CSS files are linked (@include() CSS source files, rather than
being a concatentation of the source CSS). This makes CSS development
slightly easier.
The result is that many more files are downloaded by the client, but in-browser debugging is much easier
Once you have run npm start above it will take a few moments for the Saito software to initialize and start. You will eventually see an animated Saito logo scroll across your terminal. Once that is done simply open a browser and visit:
https://127.0.0.1:12101/arcade
This will load the Saito Arcade - one of our default applications. If everything has gone as planned, you now have a working version of Saito for use in local testing or development.
Take your next steps into application development with tutorial one which explains how to build a simple application that attaches data to transactions and broadcasts them into the network.
This repository includes older branches and versions which are not being maintained. If you are interested in developing on the public site, please make sure you are using the latest two live repositories:
https://github.com/saitotech/saito-lite-rust
( JavaScript )
https://github.com/saitotech/saito-rust-workspace
( Rust )