Installation

Install Package Managers

Clean existing system environment. You can re-install these later.

Terminal

sudo rm -rf "$(which npm node yarn pnpm)" "$(where npm node yarn pnpm)"

Nix

Terminal

# Answer 'y' for all questions
sh <(curl -L https://nixos.org/nix/install) --daemon --yes

Pnpm

Terminal

curl -fsSL https://get.pnpm.io/install.sh | sh -

Re-open the terminal once installation is complete.

Set Node.js version.

Terminal

pnpm env use --global 22.13.1

Configure GitHub CLI

Create a GitHub account if you don't already have one.

Terminal

 # Login with your GitHub account.
 nix-env -iA nixpkgs.gh; gh auth login -p=https -w

Provide the following answers if prompted.

? Authenticate Git with your GitHub credentials? [Use arrows] to move, type to filter]
> Yes

# Your one-time code will be different.
! First copy your one-time code: 95i2-DAE6
Press Enter to open github.com in your browser...

Navigate to the github link shown if you see this and paste in the code as usual.

Return to the terminal when you see the Congratulations, you're all set! screen.

You should see the following:

✔ Authentication complete.
- gh config set -h github.com git_protocol https
✔ Configured git protocol
✔ Logged in as yourgithubusername

Fork and Clone Repository.

Terminal

gh repo fork mira-amm/mira-amm-web --clone; # Fork and clone repo
cd mira-amm-web; # Navigate into directory
pnpm ri; # Clean install packages, and set up .env
pnpm exec playwright install --with-deps # Install Playwright Browsers for E2E Testing

Open VSCode (Or your preferred editor):

Shell

# Allow all hosts and trust the authors when you see a popup
# And install all recommended extensions
code .

Run projects

⭐ Enjoy the project-specific IDE.

Shell

pnpm dev

Move panes & tabs: Ctrl + left/right/up/down
Toggle popup panes Ctrl + F

Installation

Install Package Managers

Nix

Pnpm

Configure GitHub CLI

Run projects

On this page