ShapeShift DAO Web Interface

This project was bootstrapped with
Create React App.

ShapeShift's OSS 2nd generation Web application. (Under Development)

Table Of Contents

• Helpful Docs
• Resources
• Requirements
• Debugging
• Quick Start
• Commands
• Developer Onboarding
• Releases
• MixPanel

Helpful Docs

• Architecture
• File Structure
• Folder Structure
• Globally Shared Code
• State Management
• Styles
• Testing
• Conventional Commits

Resources

• shapeshift

Requirements

• Node.js. Use a node version manager like nvm or check .nvmrc for the version.
• OpenJDK. Required for openapi-generator-cli to generate API clients from OpenAPI specs.

Debugging

• Rerenders

Quick Start

If you are using Linux and macOS it works out of the box following these steps:

1. Clone the repo

   On Windows, Windows Subsystem for Linux (WSL) is required. Make sure to store your clone of the repo on the WSL filesystem in order to avoid issues with line endings.

   Please do not ask our Engineering team for further help with WSL.

2. Make sure you are using the right Node.js version. This can optionally be done using a version manager like nvm:

   nvm use
   

3. Install OpenJDK.

   On MacOS via homebrew brew install java should do the trick
   if you have installed brew install openapi-generator, it should be installed automatically.
   Follow the commands to symlink the PATH for JDK & java
   To verify a proper install and link check on the java -version and it should have openJDK versions displayed alongside java version.

4. Install Dependencies:

   pnpm install
   

   Use pnpm install --frozen-lockfile instead if you're setting up a CI pipeline or trying to duplicate a historical build.

5. Build Packages:

   pnpm run build:packages
   

6. Other recommended configurations:

   To use the .git-blame-ignore-revs file to ignore specific commits, update the project's git configuration by running:

   git config --local blame.ignoreRevsFile .git-blame-ignore-revs
   

Commands

To run the app in the development mode:

pnpm run dev

It opens http://localhost:3000 to view it in the browser and the page will reload if you make edits.

Portless (optional): Install Portless globally (npm i -g portless), then dev:web uses it automatically. The app is available at http://<branch>.web.localhost:1355. Without Portless, use dev:web:localhost for plain localhost:3000.

You will also see any lint errors in the console.

To launch the test runner in interactive watch mode:

pnpm run test

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.

To build the app for production in the /build folder at the root level of the project:

MODE=production pnpm run build:web

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.

Developer Onboarding

1. Create a pull request on GitHub. (You can do this at https://github.com/<username>/<fork name>/pull/new/<branch name>.)
2. Ensure you've followed the guidelines in CONTRIBUTING.md; in particular, make sure that the title of your PR conforms to the Conventional Commits format.
3. Post a link to your new pull request in #engineering-prs in the Discord
4. (optional) Return to the develop branch to get ready to start another task.

Releases

The command pnpm run release helps to automate the release process.

Run the command and follow the prompts.

MixPanel

MixPanel is used for non-private deployments of the interface.

We have a test MixPanel environment for developing and testing. To use this, update the .env file to include:

VITE_MIXPANEL_TOKEN=dev-project-id
VITE_FEATURE_MIXPANEL=true

The MixPanel project UI will now show events from your local session.

Add Local Environment Variables

Vite supports local environment variable files that are automatically excluded from Git. You can create these files following the patterns described in the Vite documentation.

Examples of supported file names:

• .env.local (loaded in all environments)
• .env.development.local (loaded only in development)
• .env.production.local (loaded only in production)