https://github.com/indexcoop/index-app
The official web app of the Index Coop.
https://github.com/indexcoop/index-app
ethersjs react typescript web3
Last synced: 8 months ago
JSON representation
The official web app of the Index Coop.
- Host: GitHub
- URL: https://github.com/indexcoop/index-app
- Owner: IndexCoop
- Created: 2021-12-10T15:30:00.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-05-09T13:46:45.000Z (8 months ago)
- Last Synced: 2025-05-09T14:57:51.780Z (8 months ago)
- Topics: ethersjs, react, typescript, web3
- Language: TypeScript
- Homepage: https://app.indexcoop.com
- Size: 26.2 MB
- Stars: 16
- Watchers: 4
- Forks: 17
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Index App
[](https://opensource.org/licenses/MIT)
This is the official app frontend of the Index Coop.
## Local development
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
## Getting Started
1. Make a copy of the env file
```bash
cp .env.default .env.local
```
2. Install all the dependencies
```bash
npm install
```
3. Start dev mode
```bash
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
## New Token Release
- Add logo in [assets](public/assets)
- Make sure tokenlists is up2date (and has the new token added)
- Add token in [tokens.ts](src/constants/tokens.ts) - using tokenlists (check ETH2X for reference)
- Add that token object to [tokenslist](src/constants/tokenlists.ts)
- If the token is only available for either Swap or FlashMint, add an entry to `isAvailableForFlashMint` or `isAvailableForSwap` in [token utils](src/lib/utils/tokens.ts). Write a test too!
## New Presale
- Make sure the token data was added to [tokenlists](https://github.com/IndexCoop/tokenlists)
- Add logo in [assets](public/assets) - as defined in tokenlists
- Update tokenlists dependency
- Add token in [tokens.ts](src/constants/tokens.ts)
- Add presale config in [src/app/presales/constants.ts](src/app/presales/constants.ts) and update `getTokenForPresaleToken`
- Test locally w/ hardhat
## Testing
### Unit tests
Run unit tests in watch mode
```bash
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](https://github.com/IndexCoop/index-app/blob/master/CONTRIBUTING.md) for ways to get involved with our project.