This package has been deprecated

Author message:

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

@earthapro/types

EarthaPro API Types

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

Table of Contents

• Prerequisites
• Feature Implementation
• Local Environment Setup
• Production Environment Setup

Prerequisites

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

1. Create an NPM account: Visit npmjs.com and click on "Sign Up" to create a new account.
2. Join the NPM EarthaPro Group: Contact Parth or Peter to add you as a contributor to the EarthaPro Group on NPM.
3. 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:

1. Checkout the main branch and create a feature branch using the git checkout -b "feature/feature-name" convention.
2. Implement and test the feature.
3. Commit your changes to the branch with a descriptive commit message.
4. 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.
5. 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:

1. Install dependencies:

   npm install

2. Run the local build command:

   npm run build:local

   This command builds the project locally.

3. 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:

1. Install dependencies:

   npm install

2. Run the production build command:

   npm run build:prod

   This command builds the project and prepares it for publishing to npmjs.org.

3. 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: