marcogll/passkit-generator
1
0
Fork 0
mirror of https://github.com/marcogll/passkit-generator.git synced 2026-03-15 19:25:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added additional explanation steps for examples

Browse Source
This commit is contained in:
Alexander Cerutti
2021-12-11 16:27:32 +01:00
parent e35d8bede3
commit 1d4b170ea1
2 changed files with 16 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
examples/self-hosted/README.md
View File

@@ -2,11 +2,18 @@
This is examples folder. These examples are used to test new features and as sample showcases. This is examples folder. These examples are used to test new features and as sample showcases.
Each example owns an endpoint where a pass can be reached. This project is build upon Express.js, which is required to be installed. Each example owns an endpoint where a pass can be reached. This project is built upon Express.js.
Typescript compilation is done automatically through `ts-node`. Typescript compilation is done automatically through `ts-node`.
Assuming you already have cloned this repository, installed its dependencies through `npm install` and moved to `examples/self-hosted`, run these commands: Before generating a new pass, you'll have to override the `passTypeIdentifier` and `teamIdentifier` for them to match the data in your certificates. This can be done in two ways:
a) Edit manually the `pass.json` of the model you are going to run;
b) Pass the two fields in the query string of the example you are running when querying it;
Omitting this step, will make your pass unopenable.
Assuming you already installed this project its dependencies through `npm install` and moved to `examples/self-hosted`, run these commands:
```sh ```sh
$ npm install; $ npm install;

7
examples/serverless/README.md
View File

@@ -4,6 +4,13 @@ This is a sample project for showing passkit-generator being used on cloud funct
Typescript compilation happens automatically through `serverless-plugin-typescript` when serverless is started. Typescript compilation happens automatically through `serverless-plugin-typescript` when serverless is started.
Before generating a new pass, you'll have to override the `passTypeIdentifier` and `teamIdentifier` for them to match the data in your certificates. This can be done in two ways:
a) Edit manually the `pass.json` of the model you are going to run;
b) Pass the two fields in the query string of the example you are running when querying it;
Omitting this step, will make your pass unopenable.
## Configuration ## Configuration
These examples are basically made for being executed locally. In the file `config.json`, some constants can be customized. These examples are basically made for being executed locally. In the file `config.json`, some constants can be customized.