Jean Piaget API Javascript SDK

This is a SDK of our API made for js. It's built with Node.js and TypeScript.

• [x] Built with TypeScript
• [x] Jean Piaget's API access
• [x] Automatic NPM release
• [x] Complete API coverage
• [ ] Unit test coverage

• Getting Started
  • Prerequisites
  • Installation
  • Using the SDK
  • Running tests
• Project Structure
• Useful Links

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

• Node.js
• npm
• TypeScript

1. Clone the repository:

git clone https://github.com/Jean-Piaget/api-js.git
cd api-js

2. Install the dependencies:

npm install
npm install -g typescript

1. Add the SDK:

npm i @jean-piaget/api-js

To run the tests, use the following command:

npm test

This project follows a modular structure, organized around the functionality of the application. Here's a brief overview of the main directories and files:

• .github/workflows/: Contains the GitHub Actions workflow files.
• resources/: Contains static files and resources.
• src/: Contains the main source of the API SDK.
  • index.ts: File where the SDK is configured.

• Node.js
• TypeScript
• dotenv
• Axios