Repository for the v2 UI of Alchemix.
git clone https://github.com/alchemix-finance/alchemix-v2-frontend
cd alchemix-v2-frontend
cp .env.demo .env
yarn installFill the .env file with the required secrets.
Start local development server using yarn dev to fetch latest contract artifacts, or use yarn dev:noabi to skip that.
The app should be accessible on localhost:5005 by default.
This repository is using two main branches for deployments:
- The production deployment is built using
prodbranch codebase - The staging deployment is built using
stagingbranch codebase
New branches, when pushed, will also be built using our Vercel CI/CD pipeline, so minimize unneccessary pushes to tracked branches.
In general the process to contribute to the codebase looks like this:
- Find issue or new feature you want to work on
- Branch off of
stagingand use that as your working branch - Once ready, a pull request is supposed to be opened to merge your branch into
staging
With the next deployment cycle, staging and all changes in it will be merged into prod.
Use descriptive language in your commit messages. Nobody likes to chase down changes to understand what is supposed to be changed.
To make it easier for all contributors, please respect the codestyle rules.
Disable hard wrapping on save in your editor for markdown files.
Note: this requires you to have done the steps in Setup first.
Open Webstorm settings and navigate to Preferences/Languages & Frameworks/JavaScript/Prettier, select the Prettier install from the local node_modules directory, add svelte to the glob pattern and enable Run on save for files.
Source: prettier.io docs
Next, navigate to Editor & Code Style, select Project in the scheme dropdown, click the Formatter tab and add *.md to the 'Do not Format' list.
Install the svelte-vscode extension either through the marketplace, or by using the quick open command and pasting ext install JamesBirtles.svelte-vscode. Make sure VS Code settings includes
{
"[svelte]": {
"editor.defaultFormatter": "svelte.svelte-vscode"
}
}Source: svelte-vscode marketplace
Install the prettier-vscode extension either through the marketplace, or by using the quick open command and pasting ext install esbenp.prettier-vscode. Make sure VS Code settings includes
{
"editor.defaultFormatter": "esbenp.prettier-vscode"
}You may also adjust that setting on a per language basis.
Source: prettier-vscode Github
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent
