This project was bootstrapped with Create React App.
ShapeShift's OSS 2nd generation Web application. (Under Development)
- Architecture
- File Structure
- Folder Structure
- Globally Shared Code
- State Management
- Styles
- Testing
- Conventional Commits
On Linux and MacOS it works out of the box following the steps.
-
Copy sample env file:
cp sample.env .env
-
Install Dependencies:
yarn
-
Run server
yarn dev
Runs the app in the development mode.
Open
http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors
in the console.
yarn dev
Launches the test runner in the interactive watch mode.
See the section
about
running tests
for more information.
It also creates an html page you can interact with at the root level of the project in /coverage
.
yarn test
Builds the app for production to the build
folder.
It correctly bundles
React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is
ready to be deployed!
See the section about deployment for more information.
yarn build
Runs the component documentation.
Open
http://localhost:6006 to view it in the browser.
yarn storybook
If you are working with any @shapeshiftoss dependencies use yarn link
These next steps will show you how to link to the chain-adapters
repo
From your projects folder:
cd ./lib/chain-adapters && yarn link
cd ..../web/ && yarn link @shapeshiftoss/chain-adapters
Now your web's chain-adapters have a symlink to your lib's
You can use yarn run show-linked-packages
to show what is currently symlinked via yarn