festival-api-library v1.7.0

Festival library

Explaination

This project is a library to get data from the Governmental Festival API

Installation

 npm i festival-api-library

or with yarn :

 yarn add festival-api-library

Usage

To use this library, you need to import it in your project with the following command:

import getFestivals from 'festival-api-library';
const parameters = [{key: 'rows', value: '20'}, {key: 'lang', value: 'FR'}]

const festivalsData = getFestivals.data(parameters);
// or
const festivalsNames = getFestivals.names(parameters)
// or
const festivalsWebsite = getFestivals.website(parameters)
// or
const festivalsCities = getFestivals.cities(parameters)
// or
const festivalsAveragedBegins = getFestivals.averagedBegins(parameters)

For the CountryCode, we use the ISO 3166-1 alpha-2 standard for the country code.

Linter and tests

To run the linter and the tests, you need to run the following command:

npm run build

npm test

Contributing

This project was made by Clement Duvivier and Vincent Michel in peer-programming.

License

The MIT License (MIT). Please see License File for more information.