Getting started

Welcome to the Stackup monorepo! Start here to get setup for local development.

Prerequisites tools

We use the following system tools to help run Stackup locally:

Node JS ^14
Yarn ~1.22.17
Docker

This monorepo uses Yarn workspaces and Lerna to manage it's apps and packages. All commands can be called from the project root.

Install dependencies

Run the following command to install and link all the required app dependencies.

$ yarn install

App setup

Next we'll have to setup some app specific environment variables in order to get everything working end to end. See the README.md files in the following directories for more details.

Contracts - A collection of solidity smart contracts for Stackup.
Backend - REST API for supporting frontend apps.
Web - A responsive web frontend.

Running locally

Once all the environment variables are setup we can spin up an end to end instance by running the following commands in separate processes.

$ yarn dev:dependencies

$ yarn dev:backend

$ yarn dev:web

If everything is running correctly, you should be able to access Stackup on http://localhost:8080/.

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

Contact

Feel free to direct any technical related questions to the dev-hub channel in the Stackup Discord.