SolVows

This project is for the blockchain application SolVows. It contains code for the Smart Contract, web-based dapp and NodeJS server.

Contributors

Rishita Shaw
Moinak Banerjee
Shaily Shekhar

Preview

Pre-requisites

In order to develop and build "My Dapp," the following pre-requisites must be installed:

Visual Studio Code (or any IDE for editing Javascript)
NodeJS
Yarn (DappStarter uses Yarn Workspaces)
Solana CLI Tools
Rust (see "Dependency Guides" at the end for help installing)

Dependency Checklist

$ node --version
$ npm --version
$ rustup --version
$ rustc --version
$ cargo --version
$ solana --version

Windows Users

Before you proceed with installation, it's important to note that many blockchain libraries either don't work or generate errors on Windows. If you try installation and can't get the startup scripts to completion, this may be the problem. In that case, it's best to install and run DappStarter using Windows Subsystem for Linux (WSL). Here's a guide to help you install WSL.

Blockchains known to require WSL: Solana

Installation

Using a terminal (or command prompt), change to the folder containing the project files and type: yarn This will fetch all required dependencies. The process will take 1-3 minutes and while it is in progress you can move on to the next step.

Yarn Errors

You might see failures related to the node-gyp package when Yarn installs dependencies. These failures occur because the node-gyp package requires certain additional build tools to be installed on your computer. Follow the instructions for adding build tools and then try running yarn again.

Build, Deploy and Test

Using a terminal (or command prompt), change to the folder containing the project files and type: yarn start This will run all the dev scripts in each project package.json.

The first time you run yarn start there are a fair number of Rust libraries that are downloaded and pre-compiled. As a result, it may be take from 5-10 mins. before the dapp is compiled and launched the first time. On subsequent compilations, the build time will only be a few seconds.

File Locations

Here are the locations of some important files:

Program Code: packages/dapplib/programs/src/lib.rs
Dapp Library: packages/dapplib/src/dapp-lib.js
Solana Wrapper: packages/dapplib/src/solana.js
Blockchain Interactions: packages/dapplib/src/blockchain.js
Data Layouts: packages/dapplib/src/scripts/layouts.js
Deploy Script: packages/dapplib/src/scripts/deploy.js

To view your dapp, open your browser to http://localhost:5000 for the DappStarter Workspace.

Dependency Guides

This section contains installation guides for common dev environments.

Rust

(Source: Solana) We suggest that you install Rust using the 'rustup' tool. Rustup will install the latest version of Rust, Cargo, and the other binaries.

Follow the instructions at Installing Rust.

For Mac users, Homebrew is also an option. The Mac Homebrew command is brew install rustup and then rustup-init. See Mac Setup & Installing Rust for more details.

After installation, you should have rustc, cargo, & rustup. You should also have ~/.cargo/bin in your PATH environment variable.

moinak878/SolVows