generator-percipio

Generator for creating Node application to call a selected Percipio API using Axios.

If the API returns a paged data set, the application will download all available pages of data.

The JSON response of the API call will be logged to file.

Installation

Install Yeoman and this Generator using npm (we assume you have pre-installed node.js).

npm install -g yo generator-percipio

Installation from GIT

After cloning the repository, from the the folder containing this generator code create a symbolic link

npm link

Generate your new project

Make sure you have an internet connection, as the generator will need to download the current Percipio OpenAPI definitions from Percipio.

Then generate your new project:

yo percipio

You will be prompted to:

1. Create a new folder, or generate in the current working directory.
2. Select the Percipio API
3. Select the Operation

Once the generator has completed running you will need to run npm install, configure the parameters for the API call in the config/default.js file, and either populate the .env file or set environment values.

The config file will list all the configurable parameters and include derscriptions from the OpenAPI definition.

Getting To Know Yeoman

• Yeoman has a heart of gold.
• Yeoman is a person with feelings and opinions, but is very easy to work with.
• Yeoman can be too opinionated at times but is easily convinced not to be.
• Feel free to learn more about Yeoman.

License

MIT © Martin Holden 2019-2021