mirror of
https://github.com/marcogll/passkit-generator.git
synced 2026-03-15 20:25:26 +00:00
43 lines
2.8 KiB
Markdown
43 lines
2.8 KiB
Markdown
# Examples
|
|
|
|
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 built upon Express.js.
|
|
|
|
Typescript compilation is done automatically through `ts-node`.
|
|
|
|
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
|
|
$ npm install;
|
|
$ npm run example;
|
|
```
|
|
|
|
Certificates paths in examples are linked to a folder `certificates` in the root of this project which is not provided.
|
|
To make them work, you'll have to edit both certificates and model path.
|
|
|
|
Every example runs on `0.0.0.0:8080`. Visit `http://localhost:8080/:example/:modelName`, by replacing `:example` with one of the following and `:modelName` with one inside models folder.
|
|
|
|
Please note that `field.js` example will force you to download `exampleBooking.pass`, no matter what.
|
|
|
|
| Example name | Endpoint name | Additional notes |
|
|
| -------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
|
| localize | `/localize` | - |
|
|
| fields | `/fields` | - |
|
|
| expirationDate | `/expirationDate` | Accepts a required parameter in query string `fn`, which can be either `expiration` or `void`, to switch generated example. |
|
|
| scratch | `/scratch` | - |
|
|
| PKPass.from | pkpassfrom | - |
|
|
| barcodes | `/barcodes` | Using `?alt=true` query parameter, will lead to barcode string message usage instead of selected ones |
|
|
| pkpasses | `/pkpasses` | - |
|
|
|
|
---
|
|
|
|
Every contribution is really appreciated. ❤️ Thank you!
|