Kukai Services

Installation

1. Run yarn to install dependencies (install yarn if not available)
2. Run yarn dev to start a dev server

Deploy

Deployments are handled automatically with github actions (see the pipelines in .github/workflows/).

Pushing to the main branch will update production while pushing to staging will update staging:

push to /main    → updates services.kukai.app
push to /staging → updates staging.services.kukai.app

Modify

1. Navigate to the path are looking for (i.e. /version corresponds to <endpoint>/v1/version)
2. Navigate to the storage folder, modify the .json file
3. Test locally with yarn dev (i.e. localhost:8787/v1/version)

---

Api services

Production endpoint: https://services.kukai.app/

Staging endpoint: https://staging.services.kukai.app/

Service	Purpose	Endpoint
Discover	Info regarding NFT projects (for kukai.app & iOS)	/v1/discover
Explore	Info regarding the Explore page (kukai.app & iOS)	/v1/explore
Metadata	Tzkt wrapper for /tokens/balances, it augments tzkt's responses with custom metadata for specific contracts/tokens	/v1/metadata
Version	Info regarding suggested/required mobile versions (iOS & Android)	/v1/version
Proxy	A typical api proxy primarily used for ip anonymity	/v1/proxy