https://github.com/api-platform/create-client

Generate React or Vue.js-based Progressive Web Apps from an Hydra-enabled API. Also support React Native.
https://github.com/api-platform/create-client

api-platform generator hacktoberfest hydra hydra-api hydra-documentation javascript progressive-web-app react react-native reactjs redux typescript vue vuejs

Last synced: 12 days ago
JSON representation

Generate React or Vue.js-based Progressive Web Apps from an Hydra-enabled API. Also support React Native.

• Host: GitHub
• URL: https://github.com/api-platform/create-client
• Owner: api-platform
• License: mit
• Created: 2017-03-27T15:38:03.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2025-03-10T15:11:37.000Z (about 2 months ago)
• Last Synced: 2025-04-06T08:11:11.671Z (20 days ago)
• Topics: api-platform, generator, hacktoberfest, hydra, hydra-api, hydra-documentation, javascript, progressive-web-app, react, react-native, reactjs, redux, typescript, vue, vuejs
• Language: TypeScript
• Homepage: https://api-platform.com/docs/client-generator/
• Size: 1.63 MB
• Stars: 377
• Watchers: 23
• Forks: 131
• Open Issues: 53
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# API Platform Create Client

[![GitHub Actions](https://github.com/api-platform/create-client/workflows/CI/badge.svg)](https://github.com/api-platform/create-client/actions?workflow=CI)

[![npm version](https://badge.fury.io/js/%40api-platform%2Fcreate-client.svg)](https://badge.fury.io/js/%40api-platform%2Fcreate-client)

API Platform Create Client is a generator to scaffold apps with Create-Retrieve-Update-Delete features for any API exposing a [Hydra](http://www.hydra-cg.com/spec/latest/core/) or [OpenAPI](https://www.openapis.org/) documentation for:

* Next.js

* Nuxt

* Quasar

* React

* React Native

* TypeScript Interfaces

* Vue.js

* Vuetify.js

Works especially well with APIs built with the [API Platform](https://api-platform.com) framework.

## Documentation

The documentation of API Platform Create Client can be browsed [on the official website](https://api-platform.com/docs/create-client).

## Features

* Generate high-quality TypeScript or ES6 components:

  * List view

  * Creation form

  * Editing form

  * Deletion button

* Use the Hydra or OpenAPI documentation to generate the code

* Generate the suitable input type (`number`, `date`...) according to the type of the API property

* Display of the server-side validation errors under the related input (if using API Platform Core)

* Client-side validation (`required` attributes)

* The generated HTML is compatible with [Bootstrap](https://getbootstrap.com/) and includes mandatory classes

* The generated HTML code is accessible to people with disabilities ([ARIA](https://www.w3.org/WAI/intro/aria) support)

* Bring your own templates

## Usage

### Hydra

    npm init @api-platform/client https://demo.api-platform.com/ output/ --resource Book

### OpenAPI 3

    npm init @api-platform/client https://demo.api-platform.com/docs.json output/ --resource Book --format openapi3

## Credits

Created by [Kévin Dunglas](https://dunglas.fr).

Sponsored by [Les-Tilleuls.coop](https://les-tilleuls.coop).

Commercial support is available upon request.