Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/klaytn/klaytn-dex-frontend
https://github.com/klaytn/klaytn-dex-frontend
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/klaytn/klaytn-dex-frontend
- Owner: klaytn
- License: mit
- Created: 2022-05-30T03:28:02.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2024-07-19T06:58:09.000Z (2 months ago)
- Last Synced: 2024-07-19T15:01:57.099Z (2 months ago)
- Language: TypeScript
- Homepage:
- Size: 9.47 MB
- Stars: 15
- Watchers: 11
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-klaytn - Dex Frontend
README
[](http://unmaintained.tech/)
# NO LONGER MAINTAINED
> [!IMPORTANT]
> Since the launch of Kaia Blockchain, this repository has been parked in favour of the new open-source projects in [Kaia's Github](https://github.com/kaiachain). Contributors have now moved there continuing with massive open-source contributions to our blockchain ecosystem. A big thank you to everyone who has contributed to this repository.
>
> For future development and contributions, please refer to the new [open-dex-frontend repository](https://github.com/kaiachain/open-dex-frontend)
>
> More information about Klaytn's chain merge with Finschia blockchain, please refer to the launching of Kaia blockchain [kaia.io](https://kaia.io).
---
# Klaytn-DEX Frontend Documentation
Here you can find Klaytn-DEX frontend documentation:
- [User Guide](docs/guide.md) provides instructions on how to interact with Klaytn-DEX
- [Frontend Specification](docs/modules.md) describes the Klaytn-DEX module structure
- [Deployment Guide](docs/deploy.md) provides instructions on how to deploy Klaytn-DEX
## Local Development
```bash
pnpm i
# run dev server
pnpm dev
# run unit tests in watch mode
pnpm vitest
# open cypress
pnpm cy
# fix formatting
pnpm format:fix
# static analysis
pnpm typecheck
pnpm lint
```
## CI/CD
First of all, create `.env.local` file. Use `.env.example` as a reference.
Commands:
```bash
pnpm i
# check code formatting
pnpm format:check
# run static analysis
pnpm typecheck
pnpm lint
# run both unit & component tests
pnpm test
# build
pnpm build
```
In line with our commitment to decentralization, all Klaytn codebase and its documentations are completely open source. Klaytn always welcomes your contribution. Anyone can view, edit, fix its contents and make suggestions. You can either create a pull request on GitHub or create a enhancement request. Make sure you check out our guidelines before contributing:
- [Contribution Guide](./CONTRIBUTING.md)
- [License](./LICENSE)
- [Code of Conducts](./code-of-conduct.md)