# cloudos-gitee-api

**Repository Path**: peiiii/cloudos-gitee-api

## Basic Information

- **Project Name**: cloudos-gitee-api
- **Description**: Manage your Gitee account in javascript
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-11-22
- **Last Updated**: 2023-01-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div id="top"></div>
<div align="center">
  <h3 align="center">Gitee API</h3>
  <p align="center">
    <b>Manage your Gitee account in javascript.</b>
    <!-- <br/> -->
       <!-- <a href="README_CN.md">中文文档</a> -->
</p>
</div>

## About The Project
This library provides easy-to-use javascript/typescript apis to access gitee.com data like user info, repo, branch and files;
          
### Built With
* typescript
* axios

## Getting Started
1. Install this library `npm i @cloudos/gitee-api` or `yarn add @cloudos/gitee-api`.
2. Using the apis in your code;
```js
import giteeApi from '@cloudos/gitee-api';
client=giteeApi.createGiteeClient({accessToken:"xxx"});
client.File.add({owner:"your-gitee-username",repo:"your-gitee-repo",path:"/test.txt",content:"test message for gitee api",message:"add file /test.txt", branch:"master"}).then(()=>{
    console.log("Success.");
});
```
### Usage
Check the apis defined in the code ([src/index.ts](src/index.ts)), it's not complicated.

## License
MIT License.

<p align="right">(<a href="#top">back to top</a>)</p>