@izgas/backlog-api 🚀

@izgas/backlog-api is a TypeScript library for seamless integration with the Nulab Backlog API. Designed for Google Apps Script, it enables efficient interaction with Backlog resources, including projects, issues, and user management. 💻

Features ✨

• Full integration with Nulab Backlog API. 🌐
• Optimized for Google Apps Script. ⚙️
• TypeScript support for robust type checking. ✅
• Access to Backlog API endpoints: projects, issues, and users. 📊

Table of Contents 📚

• Features
• Installation
  • With Global Type Library
• Usage
• API Documentation
• Development
  • Prerequisites
  • Setup
  • Running Tests
• Contributing
• License
• Acknowledgments

Installation 📦

Install the package with pnpm or npm:

pnpm install @izgas/backlog-api

With Global Type Library 🌍

For global type definitions, install:

pnpm install -D @iztypes/backlog-api

Update tsconfig.json to include the type definitions:

{
  "compilerOptions": {
    "types": ["@iztypes/backlog-api"]
  }
}

Usage 🛠️

The content of this section is currently being updated. Please check back later for detailed usage instructions.

API Documentation 📖

The content of this section is currently being updated. Please check back later for detailed API documentation.

Development 🛠️

Prerequisites 📋

• Node.js (latest LTS version). 🖥️
• pnpm (preferred package manager). 📦

Setup ⚙️

1. Clone the repository:

   git git@github.com:2zcory/backlog-api.git
   cd izgas-backlog-api

2. Install dependencies:

   pnpm install

3. Build the project:

   pnpm build

Running Tests ✅

Run the test suite:

pnpm test

Contributing 🤝

Contributions are welcome. Please:

1. Fork the repository. 🍴
2. Create a branch for your feature or fix. 🌿
3. Commit and push your changes. 📤
4. Submit a pull request with a detailed description. 📋

License 📜

Distributed under the MIT License. See LICENSE for details. ⚖️

Acknowledgments 🙌

• Nulab Backlog API Documentation 📘
• Community contributors for feedback and input. 🌟