PrimeDAO / prime-launch-dapp

https://launch.prime.xyz
6 stars 13 forks source link

Prime Launch dApp

Prime Launch is a decentralized and curated token offering platform powered by Balancer v2.0 that enables fair and user-friendly token launches. An introduction to Prime Launch can be found here.

This prime-launch-dapp repository contains in its master branch the web user interface for the Prime Launch website that is deployed to https://launch.prime.xyz.

Development

Prerequisites

Make sure you have node.js version >= 14.11.0

Install

Install dependencies with the following command:

npm ci

Update Contract ABIs

Prime Launch relies on solidity contract addresses and ABIs that it obtains from the PrimeDao contracts-v2 repository. You must clone the contracts-v2 repository in a folder sibling to this one.

Then run the following script to pull the required contract ABIs from contracts-v2:

npm run fetchContracts

You only need run this script once, or else again when any of the contracts change.

Build

The package.json file contains lots of commands for building or serving up the application.

Environment

Before building, make sure to have the following in your OS environment variables or in an ".env" file:

RIVET_ID=
INFURA_ID=
ETHERSCAN_KEY=
PINATA_API_KEY=
PINATA_SECRET_API_KEY=
PINATA_API_KEY_TEST=
PINATA_SECRET_API_KEY_TEST=
IPSTACK_API_KEY=
IPFS_GATEWAY=https://[insert gateway]/${protocol}/${hash}

When building for production, the build will look for variables in ".env.production".

Following are the two most commonly used commands:

Build and serve unoptimized code against goerli

Best for development and debugging, the output goes to webpack-dev-server for use with your favorate debugger, like VSCode:

npm run serve-dev

Build with optimized code against mainnet

The production build, output goes to the dist folder:

npm run build

After successfully building, run the following to serve up the output so you can see it in the browser:

npm run start

Lint

To confirm that lint succeeds before git commits run

npm run lint

To have lint automatically fix all fixable errors run

npm run lint.fix

Automated Tests

Run

npm run test

To run in watch mode

npm run test --watch

Webpack Analyzer

To run the Webpack Bundle Analyzer for production build.

npm run analyze

Dependencies

Various code dependencies include:

Releasing

npm version [patch|minor|major]
npm run changelog
git tag -a v2.0.2 -m "v2.0.2"
git push --follow-tags

Architecture

Technical Description

The project framework is Aurelia.

It is written mostly in Typescript, HTML and SCSS, and is bundled using Webpack.

Community

Join our Discord and ask how you can get involved with PrimeDAO