Skip to content

ZIP-558: Initial Node SDK foundation#1

Merged
ericlakich merged 2 commits intomainfrom
ZIP-558/node-sdk-foundation
Jan 22, 2026
Merged

ZIP-558: Initial Node SDK foundation#1
ericlakich merged 2 commits intomainfrom
ZIP-558/node-sdk-foundation

Conversation

@ericlakich
Copy link
Contributor

This pull request sets up the foundational project structure and tooling for the ZipTax Node.js SDK. It introduces configuration and workflow files for development, testing, linting, formatting, publishing, and environment management. It also adds documentation, licensing, and example usage scripts to help users get started quickly and understand the SDK's capabilities.

The most important changes are:

Project Configuration and Tooling:

  • Added .eslintrc.json and .prettierrc.json for TypeScript linting and code formatting standards. [1] [2]
  • Added .npmignore to ensure only necessary files are published to npm.
  • Added .env.example to provide a template for required environment variables, including the ZipTax API key.

CI/CD Workflows:

  • Introduced GitHub Actions workflows for testing (test.yml) and publishing (publish.yml) the package, supporting multi-platform testing, linting, type checking, coverage reporting, and automated npm publishing. [1] [2]

Documentation and Licensing:

  • Added a comprehensive README.md with installation, usage, API reference, error handling, examples, and contribution guidelines.
  • Added a CHANGELOG.md following Keep a Changelog and Semantic Versioning.
  • Added an MIT LICENSE file.

Example Scripts:

  • Added example scripts for basic usage, async operations, and error handling in the examples/ directory to demonstrate SDK features and best practices. [1] [2] [3]

@linear
Copy link

linear bot commented Jan 22, 2026

@ericlakich ericlakich merged commit 39abbe2 into main Jan 22, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant