StoneNFT

This repo contains all of the source code for the Roo Troop NFT project, including the following:

1. The Roo Troop NFT Contract (Roo Troop)
2. Art Generation Scripts
3. Whitelist Processing Scripts
4. Off-Chain Whitelist Backend
5. Companion Contract (Joey)
6. Staking Contract (xRooStaking)
7. Mint/Staking UIs (Written in React.js/Typescript)
8. The $ROOLAH Shop UI/backend

Notes

For the majority of the sub-projects, I use Node.js with lerna, before getting started, it'd be good to do the following:

1. Clone into the repo with your git client of choice (I love Sublime Merge, but that's because I don't care for CLI tools)
2. Ensure that you have node/npm installed on your machine. I use node v16.13.1, npm 8.1.2.
3. Ensure that you use npm to locally download yarn npm install --global yarn

Working in Lerna

When working in lerna, it's important to note that the packages are all sym-linked together when being referenced from each other with import {...} from '@roo/...' syntax. Never reference other packages with relative paths. The symlink is built off of the /lib or /dist dirs of each package, so to ensure that one package has the newest reference to another, run yarn build in that dependency package or yarn lerna run build --scope=@roo/<package-suffix> from the root. This will commonly be used in the backend code or when dealing with the shared package in the UI code.

Roo Troop UI Monorepo

Getting bootstrapped

1. Follow the instructions in Notes
2. Navigate to the /web directory
3. Run yarn install (downloads lerna and others)
4. Run yarn bootstrap (links packages together with symlinks)
5. Now you are ready to go with yarn build to build all packages or yarn lerna run build --scope=@roo/<package-suffix> for a particular package.
6. You can build for production with yarn build:prod for all packages or yarn lerna run build:prod --scope=@roo/<package-suffix> for a particular package.

$ROOLAH Shop Backend

Getting bootstrapped

Dependencies

• MySQL (5.7.32 in prod, 5.7.36 in asdf)
• ENV vars in /shop_backend/packages/Webserver/.env

Instructions

1. Follow the instructions in Notes
2. Navigate to the /shop_backend directory
3. Run yarn install (downloads lerna and others)
4. Run yarn bootstrap (links packages together with symlinks)
5. Now you are ready to go with yarn start:fresh to start and kill anything already using the port or yarn start otherwise.

Getting Started with Heroku

1. Download the Heroku CLI following https://devcenter.heroku.com/articles/heroku-cli
2. Navigate to /shop_backend and run heroku login in your terminal of choice
3. Make changes and PR/commit to master
4. Change to the master branch
5. Run git subtree push --prefix shop_backend heroku master to generate and push a subtree where shop_backend is the root so that Heroku can find and start the Node.js server.