Skip to content

README.md

Latest commit

 

History

History
59 lines (37 loc) · 2.2 KB

README.md

File metadata and controls

59 lines (37 loc) · 2.2 KB

license Crowdin Follow on Twitter

Jumper.XYZ

This is the jumper.xyz repository that gets deployed to develop.jumper.xyz, staging.jumper.xyz and jumper.xyz.

Getting Started

In the root directory run the following commands to get started:

pnpm install

to install all dependencies, and choose one of these start commands to start the development vite server and to start building packages in watch mode.

pnpm dev
pnpm dev:local
pnpm dev:staging
pnpm dev:production

Tools

Most recent parts of the code rely on API generated from our backend's swagger configuration. With the backend running locally (on localhost:3001), you can generate the latest version of the API using:

pnpm api

The generated file requires linting, this should be automatic.

Lint and checks

We use husky and lint-staged to run checks and linting on your code before you commit.

Husky should be installed automatically when you run pnpm install.

lint-staged

The idea of invoking tsc --noEmit from bash instead of yarn comes from here: github issue It fixes some problems we had with lint-staged ignoring our tsconfig and not working properly.

Contributing Translations

We appreciate your interest in helping translate our project!

If you'd like to contribute translations, please visit our Crowdin project page at Crowdin Jumper Exchange and Crowdin LI.FI Widget. Register on Crowdin and you can start translating the project into your preferred language. Your contributions will help make our project accessible to a wider audience around the world.

Thank you for your support!