README.md

This is a Next.js project bootstrapped with create-next-app.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Project structure

.
├── src                         # Source files (alternatively `lib` or `app`)
│   ├── component               # Common components, as pure as possible, if component too complex, create a directory
│   ├── config                  # Project common settings, e.g. wallet support chain
│   ├── icons                   # Image files
│   ├── hooks                   # Project common hooks, don't put zustand store or feature usage only hook here
│   ├── pages                   # Entry page of each feature, ONLY write initial data fetching or zustand actions dispatch
│   ├── features                # Project page files, separate by domain
│   │   ├── Swap
│   │   │   ├── index.tsx       # Main page of each feature
│   │   │   ├── useXXStore.ts   # Feature use ONLY zustand store, for sharing store, put in src/store
│   │   │   ├── util.ts         # Feature use ONLY util, for sharing, put in src/util
│   │   │   └── components
│   │   └── ....(other feature pages, e.g. farm, pool)
│   ├── store                   # Sharing zustand store, use store/createStore to create a new store for easier debugging
│   ├── provider                # Common providers, usually wrap App component in pages/_app.tsx file
│   └── util                    # Common utility functions
└── README.md

Coding rules

1. Zustand store should define actions(function) and state in initialization
2. Use zustand action to call api or async operations as possible, DO NOT wrapped it in every hooks
3. Common components should be as pure as possible, reduce side effects if wants to add features, add new props to control it
4. Components in src/features/xxx/components should also be as pure as possible, let index.tsx pass functions and props into it (prevent business logic separate in everywhere

Components Map

• <TokenAvatar> extends Chakra's <Avatar>, for avatar may be clickable/linkable in future, write this manually everytime is too complicated
  • prop:token coin's SplToken
• <TokenSymbol> extends Chakra's <Text>, for text may have tooltip in future, write this manually everytime is too complicated
  • prop:token coin's SplToken
• <Button> extends Chakra's <Button>
  • prop:validators handle app easy to see validation conditions
• <ChartPanel> styled chart
• <MessageBox> simple message display
  • prop:title message title
  • prop:status message level, current support: warning | error | info, default is info
  • prop:icon icon beside title
  • prop:children for message more than a simple string, you could wrap them as children
• <MessageStrip> message display
  • prop:title message title
  • prop:desc message description
  • prop:status message level, current support: info | warning
  • prop:icon icon beside title
  • prop:children for more detail about message information, you could wrap them as children
  • prop:renderControlAction extra interactive/action relative to message

hooks Map

• useIsomorphicLayoutEffect() useLayoutEffect()'s SSR version. Avoid bug report in CMD(name is conventional)
• useEvent() make function dependence always update but function address never change(it hook is suggested by Dan Abramov)
• useSearch() a wrapper of searchItems
• useToast() a wrapper of chakra toast w/ Raydium style

utils Map

• searchItems() apply search logic, it will only sort the result by match condition (TODO: support sort factor)