-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'feature/update-readme' into develop
- Loading branch information
Showing
2 changed files
with
27 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,50 +1,36 @@ | ||
# React + TypeScript + Vite | ||
# MyTonSwap App | ||
|
||
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. | ||
![MyTonSwap Preview](assets/image.png) | ||
|
||
Currently, two official plugins are available: | ||
## Overview | ||
|
||
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh | ||
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh | ||
MyTonSwap is a decentralized exchange platform on the TON blockchain, providing instant token swaps with the best rates and high liquidity. | ||
|
||
## Expanding the ESLint configuration | ||
## Getting Started | ||
|
||
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: | ||
### Prerequisites | ||
|
||
- Configure the top-level `parserOptions` property like this: | ||
- Node.js (version 20.x) | ||
- pnpm (version 7.x) | ||
|
||
```js | ||
export default tseslint.config({ | ||
languageOptions: { | ||
// other options... | ||
parserOptions: { | ||
project: ['./tsconfig.node.json', './tsconfig.app.json'], | ||
tsconfigRootDir: import.meta.dirname, | ||
}, | ||
}, | ||
}) | ||
``` | ||
### Installation | ||
|
||
1. Clone the repository: | ||
|
||
```sh | ||
git clone https://github.com/mytonswap/app.git | ||
cd mytonswap-frontend | ||
``` | ||
|
||
2. Install dependencies: | ||
```sh | ||
pnpm install | ||
``` | ||
|
||
### Running the Application | ||
|
||
To start the development server, run: | ||
|
||
- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked` | ||
- Optionally add `...tseslint.configs.stylisticTypeChecked` | ||
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config: | ||
|
||
```js | ||
// eslint.config.js | ||
import react from 'eslint-plugin-react' | ||
|
||
export default tseslint.config({ | ||
// Set the react version | ||
settings: { react: { version: '18.3' } }, | ||
plugins: { | ||
// Add the react plugin | ||
react, | ||
}, | ||
rules: { | ||
// other rules... | ||
// Enable its recommended rules | ||
...react.configs.recommended.rules, | ||
...react.configs['jsx-runtime'].rules, | ||
}, | ||
}) | ||
```sh | ||
pnpm run dev | ||
``` |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.