@earthapro/types NPM

EarthaPro API Types

This repository contains type definitions for the EarthaPro API. These types are used to ensure consistent data structures across the API.

Prerequisites

Before you can contribute to the EarthaPro API, you need to:

Create an NPM account: Visit npmjs.com and click on "Sign Up" to create a new account.
Join the NPM EarthaPro Group: Contact Parth or Peter to add you as a contributor to the EarthaPro Group on NPM.
Login to your NPM account on your local machine: Run npm adduser in your terminal and follow the prompts to login into your NPM account.

Feature Implementation

Follow these steps to implement a new feature:

Checkout the main branch and create a feature branch using the git checkout -b "feature/feature-name" convention.
Implement and test the feature.
Commit your changes to the branch with a descriptive commit message.
Run npm run build:prod to prepare the feature for publishing to the npm registry. Alternatively, run npm run build:local to test the build locally.
Push the branch and create a pull request (PR) to merge your changes into the main branch.

Local Environment Setup

To set up your local environment for development, follow these steps:

Install dependencies:
```
npm install
```
Run the local build command:
```
npm run build:local
```
This command builds the project locally.
Prebuild and postbuild hooks:
These are scripts that run before and after the build process respectively. They can be defined in the package.json file under the scripts section. For example:
```
"scripts": {
"prebuild:local": "rm -rf dist",
"build:local": "tsc",
"postbuild:local": "cp package.json ./dist/package.json"
}
```

Production Environment Setup

To prepare your project for production, follow these steps:

Install dependencies:
```
npm install
```
Run the production build command:
```
npm run build:prod
```
This command builds the project and prepares it for publishing to npmjs.org.

Prebuild and postbuild hooks:

These are scripts that run before and after the build process respectively. They can be defined in the package.json file under the scripts section. For example:

"scripts": {
"prebuild:prod": "rm -rf dist",
"build:prod": "tsc && npm version patch -m \"Bump to %s\"",
"postbuild:prod": "cp package.json ./dist/package.json && npm publish --access public ./dist"
}

GitHub and NPM Repository

The code for this project is hosted on GitHub and the package is published on NPM. You can access them at the following URLs:

yup uuid stripe mongodb email-validator @stripe/stripe-js libphonenumber-js @aws-sdk/client-cognito-identity-provider

12 months ago

12 months ago

12 months ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

12 months ago

1 year ago

12 months ago

1 year ago

12 months ago

1 year ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

12 months ago

1 year ago

1 year ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

@earthapro/types v1.1.1

EarthaPro API Types

Table of Contents

Prerequisites

Feature Implementation

Local Environment Setup

Production Environment Setup

GitHub and NPM Repository