README.md

Index App

This is the official app frontend of the Index Coop.

Local development

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

Getting Started

1. Make a copy of the env file

cp .env.default .env.local

2. Install all the dependencies

npm install

3. Start dev mode

npm run dev

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

New Token Release

• Add logo in assets
• Make sure tokenlists is up2date (and has the new token added)
• Add token in tokens.ts - using tokenlists (check ETH2X for reference)
• Add that token object to tokenslist
• If the token is only available for either Swap or FlashMint, add an entry to isAvailableForFlashMint or isAvailableForSwap in token utils. Write a test too!

New Presale

• Make sure the token data was added to tokenlists
• Add logo in assets - as defined in tokenlists
• Update tokenlists dependency
• Add token in tokens.ts
• Add presale config in src/app/presales/constants.ts and update getTokenForPresaleToken
• Test locally w/ hardhat

Testing

Unit tests

Run unit tests in watch mode

npm run test:watch

Contributing

The main purpose of this repository is to continually serve the needs of Index, making it faster, simpler, and easier to use. As new proposals are submitted and the scope of Index's governance evolves, we anticipate this tool will change as well.

We greatly encourage any community contribution that may help Index reach more users and promote greater adoption, so be sure to check out our Contribution Guidelines for ways to get involved with our project.