Stellar📡Expert

StellarExpert – block explorer and analytics platform for Stellar Network.

API Server

cd api
npm i

All configuration parameters stored in app.config.json file.

Copy the template config file and edit parameters:

cp example.app.config.json app.config.json

port - API server port
apiCacheDisabled - set to true to disable response caching (recommended for development environment)
networks - supported Stellar networks configuration
- db - connection string Mongodb database with ingested ledger data
- horizon - URL of the public Horizon server,
- network - network identifier
directory - public Directory configuration
- repository - Github repository identifier in the format {owner}/{repository}
- accessToken - Github access token for the bot with repository access
- admins - handles of the users with write permissions to the repository
oauth - OAuth providers configuration
- clientId - application ClientId obtained from OAuth provider
- secret - corresponding secret
corsWhitelist - array containing all origins that will have CORS enabled for all requests

node api.js

(for verbose HTTP requests logging pass MODE=development environment variable)

cd ui
pnpm i

(requires PNPM package manager to be installed)

All configuration parameters stored in app.config.json file.

apiEndpoint - URL of the API sever
networks - supported Stellar networks configuration
- passphrase - network passphrase
- horizon - URL of the public Horizon server,
- title - friendly name
directoryAdmins - handles of the users with write permissions to the Directory repository
oauth - OAuth providers configuration
- clientId - application ClientId obtained from OAuth provider

Additional build options are located in webpack-config.js

pnpm dev-server

(check webpack dev-server output for the hot-reload browser link)

pnpm build

(check for the generated files in the ./public repository)

pnpm build-api-docs