Home Explore Help
Sign In
PreMiD
/
Presences
mirror of https://github.com/PreMiD/Presences.git
Watch 2
Star 0
Fork 0
Files Issues
Branch: main
Branches Tags
Presences
/
cli
github plz bring back DarkVIllager d185dd7ec4 fix(CLI): make options consistent (#9358) 1 hour ago
..
src d185dd7ec4 fix(CLI): make options consistent (#9358) 1 hour ago
templates 239a48fad8 feat: modernize repo (#9184) 2 weeks ago
README.md 239a48fad8 feat: modernize repo (#9184) 2 weeks ago
package-lock.json 6742759cba chore(cli): fix punycode deprecation warning (#9340) 4 days ago
package.json 6742759cba chore(cli): fix punycode deprecation warning (#9340) 4 days ago
tsconfig.json 239a48fad8 feat: modernize repo (#9184) 2 weeks ago
vitest.config.ts 239a48fad8 feat: modernize repo (#9184) 2 weeks ago

README.md

CLI

The CLI is used to build the services, and when in dev mode, it will watch for changes and rebuild the services.

API Versionizing

Default (api version specified in metadata.json): /websites/<letter>/<service>/metadata.json

If there is support for multiple api versions, the api version is specified in the metadata.json file and folder /websites/<letter>/<service>/v1/metadata.json /websites/<letter>/<service>/v2/metadata.json

Building steps

  • install dependencies
  • typecheck
  • compile the presence.ts file to dist
  • compile the iframe.ts file to dist (if it exists)
  • copy the metadata.json file to dist
  • copy the .json file to dist (if it exists)

    • Dev mode

    • watch for changes and rebuild the services
    • connect to extension