A started project to get started on developing a provider package. It includes sample provider, typescript support, npm scripts to build and test (in an android device) packages easily.
- NodeJs
- NPM
- ADB
- Android Device (preferebly emulator) with app installed and
Developer modeon.
git clonethis (package-starter)- Open terminal
cdto root dir of this project.npm installnpm run test- You should see
Ran all test suites. - Modify files in
./srcto your needs. - Build package with
npm run build
- Serve package with
npm run serve(Only need to do once) - Ensure running
adb devicesreturns one device and the android app is installed. - Run
npm run helpto see command line options and adjust parameters inscriptsinpackage.json - Install and run package on an android device with
npm run execute - Android app should install the package (uninstalls rest packages to avoid conflict) and launch search screen.
- Upload
manifest.jsonand generated package file (index.js/express.json) in./distdirectory. - Reach out to a vendor to include your package manifest url in their manifest (as seen in
/src/manifest.vendor.json)
- Only publish a vendor manifest if you are a vendor maintainer. Do not publish vendor manifest just for your package.
- Urge existing vendors to include your package before you deploy your own. Ideally there should be only ONE vendor that has all packages.
- Multiple vendors will confuse users and make configuration complicated. Avoid this at all cost.
- To publish a vendor manifest, upload
./dist/manifest.vendor.json. - Use a url shortener (preferebly
bit.ly) to shorten the url that can be easily typed in the app. - Share this shortened url to users.
- For
Expresspackages drop your existing express package in place of/src/express.json. - For
Kosmospackages import your javascript in/src, adapt it until typescript errors are gone. - Change
/src/manifest.jsonas needed. Ensure thetype(possible values areexpressandkosmos) andurlfield (points to the the generatedindex.js/express.jsonafter publishing) reflect correct values. - Build, test and publish your package using documentation above.
See Express package doc ./docs/express.md See managed accounts doc ./docs/managed-accounts.md