Skip to content

Safrochain-Org/SafroDappList

Repository files navigation

SafrodAppList

Community dApp directory for the Safrod ecosystem. Each listing lives in this repo as JSON + a logo; registry.json aggregates every entry for apps and websites to consume.

Using the data

Fetch the merged registry (replace ORG, REPO, and REF with your fork or SAFROCHAIN/SafrodAppList and main):

https://raw.githubusercontent.com/ORG/REPO/REF/registry.json

Each item includes manifest fields plus manifestPath and logoPath (paths inside the repo). Build logo URLs by prefixing the same raw base, for example:

https://raw.githubusercontent.com/ORG/REPO/REF/apps/<slug>/img/logo.png

The JSON schema for each manifest is schemas/app.manifest.schema.json.

Repository layout

apps/
  <slug>/
    json/app.json    # manifest (slug must match folder name)
    img/logo.png     # 512×512 PNG
schemas/
  app.manifest.schema.json
scripts/
  validate.mjs       # local + CI checks
  build-registry.mjs   # regenerate registry.json
registry.json        # generated; commit with app changes

Folder <slug>: 2–64 characters, lowercase letters and digits only (no spaces or hyphens).

Scripts

Command Purpose
npm ci Install dependencies (use in CI and locally).
npm run validate Schema check, slug rules, logo size/format, duplicate slugs, registry sync.
npm run build:registry Rebuild registry.json from all apps/*/json/app.json.
npm run listcategories Print allowed category values (one per line).
npm run listenums Print allowed values for category, status, and chains.

Requires Node.js 20+.

Contributing

See CONTRIBUTING.md for the full checklist. In short: run npm run validate until it passes, then npm run build:registry and commit registry.json in the same pull request.

Issue and PR templates live under .github.

License

MIT

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors