@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:

``bash
pnpm install @izgas/backlog-api
`

$3

For global type definitions, install:

`bash
pnpm install -D @iztypes/backlog-api
`

Update tsconfig.json to include the type definitions:

`json
{
"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 🛠️

$3

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

$3

1. Clone the repository:

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

2. Install dependencies:

`bash
pnpm install
`

3. Build the project:

`bash
pnpm build
`

$3

Run the test suite:

`bash
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. 🌟