https://github.com/syucream/holaspirit-client-typescript-fetch
A TypeScript client for the Holaspirit API, generated from the official OpenAPI specification using openapi-fetch.
https://github.com/syucream/holaspirit-client-typescript-fetch
holaspirit openapi
Last synced: 2 days ago
JSON representation
A TypeScript client for the Holaspirit API, generated from the official OpenAPI specification using openapi-fetch.
- Host: GitHub
- URL: https://github.com/syucream/holaspirit-client-typescript-fetch
- Owner: syucream
- License: mit
- Created: 2025-01-13T02:01:21.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-03-30T09:40:58.000Z (6 days ago)
- Last Synced: 2026-03-30T11:36:01.383Z (6 days ago)
- Topics: holaspirit, openapi
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/holaspirit-client-typescript-fetch
- Size: 40 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Holaspirit TypeScript Client
A TypeScript client for the Holaspirit API, generated from the official OpenAPI specification using [openapi-fetch](https://github.com/openapi-ts/openapi-typescript).
## Installation
```bash
npm install holaspirit-client-typescript-fetch
```
## Usage
```typescript
import createHolaspiritClient from 'holaspirit-client-typescript-fetch';
// Create a client instance
const client = createHolaspiritClient('https://app.holaspirit.com');
// Example: Get organizations
const { data, error } = await client.GET('/api/organizations');
if (error) {
console.error('Error fetching organizations:', error);
} else {
console.log('Organizations:', data);
}
```
## Technical Stack
- TypeScript
- [openapi-fetch](https://github.com/openapi-ts/openapi-typescript) - Type-safe API client generator
- [openapi-typescript](https://github.com/openapi-ts/openapi-typescript) - OpenAPI to TypeScript type generator
## Development
1. Clone the repository
2. Install dependencies:
```bash
npm install
```
3. Generate the client code:
```bash
npm run generate
```
4. Build the project:
```bash
npm run build
```
### Code Quality
The project uses ESLint and Prettier for code quality and formatting:
- `npm run lint` - Check code style and potential issues
- `npm run fix` - Automatically fix code style issues
Individual commands are also available:
- `npm run lint:eslint` - Run ESLint checks only
- `npm run lint:prettier` - Run Prettier checks only
- `npm run fix:eslint` - Run ESLint auto-fix
- `npm run fix:prettier` - Run Prettier auto-fix
### Continuous Integration
The project uses GitHub Actions for CI:
- Pull Request Checks:
- Runs linting on all pull requests
- Ensures code quality before merging
- Main Branch CI:
- Runs on merges to main
- Generates client code from the latest OpenAPI spec
- Builds the project
- Uploads build artifacts
## Publishing
This package is published to GitHub Packages. To publish a new version:
1. Update the version in `package.json`
2. Make sure you're authenticated with GitHub Packages
3. Run:
```bash
npm publish
```
## License
MIT