# redmine-api

**Repository Path**: nieyong/redmine-api

## Basic Information

- **Project Name**: redmine-api
- **Description**: redmine-api.git clone from github
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-05
- **Last Updated**: 2022-05-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Redmine API
Use Redmine API in browsers and NodeJS

## Install
```sh
npm install redmine-apis
```

## Quick Sample
```js
import { RedmineAPI } from 'redmine-apis';

const api = new RedmineAPI('https://domain.com', { login: 'user', password: 'pass' });
// or
const api = new RedmineAPI('https://domain.com', { key: 'your_api_key' });

// You can pass all ressources name
api.query('issues')
  .then(results =>  {
    // ...
  })
  .catch(err => {
    // ...
  });
```

## Docs
[See here](docs/README.md) for documentation

## Implemented
- [x]  API Requester class ([docs](docs/redmine-api.md))
- [x]  Issues ([docs](docs/issues.md))
- [x]  Projects ([docs](docs/projects.md))
- [x]  Time entries ([docs](docs/time_entries.md))
- [ ]  Users
- [ ]  Enumerations
- [ ]  Custom fields
- [ ]  Versions
- [ ]  Issue Relations
- [ ]  Issue Statuses
- [ ]  Issue Categories
- [ ]  Attachments
- [ ]  Trackers
- [ ]  Groups
- [ ]  Roles
- [ ]  News
- [ ]  Wiki Pages
- [ ]  Queries

## NodeJS & old browsers
You will need `fetch()` function to do requests on Redmine API. You can get a polyfill :
  - For NodeJS : https://www.npmjs.com/package/node-fetch
  - For old browsers : https://www.npmjs.com/package/whatwg-fetch

## License
See `LICENSE` file