Skip to content

feat: rename the package @api-platform/create-client #337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 9, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Node.js Build and Test
name: CI

on:
pull_request:
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ Then, if it appears that it's a real bug, you may report it using Github by foll
To install the source version of the API Platform Client Generator in your project and contribute a patch, run the following commands:

```console
$ git clone [email protected]:api-platform/client-generator.git
$ cd client-generator
$ git clone [email protected]:api-platform/create-client.git
$ cd create-client
$ yarn install
$ yarn watch
```

You can now hack in the cloned repository of `client-generator`. If you want to test your work, a `lib/index.js` file containing your last changes will be created each time you invoke `yarn build`. You can also use `yarn watch` to make it created each time a change is performed in your code!
You can now hack in the cloned repository of `create-client`. If you want to test your work, a `lib/index.js` file containing your last changes will be created each time you invoke `yarn build`. You can also use `yarn watch` to make it created each time a change is performed in your code!

### Testing your changes

Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# API Platform Client Generator

[![Build Status](https://travis-ci.org/api-platform/client-generator.svg?branch=master)](https://travis-ci.org/api-platform/client-generator)
[![npm version](https://badge.fury.io/js/%40api-platform%2Fclient-generator.svg)](https://badge.fury.io/js/%40api-platform%2Fclient-generator)
[![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 Client Generator is a generator to scaffold app 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:

Expand All @@ -18,7 +18,7 @@ Works especially well with APIs built with the [API Platform](https://api-platfo

## Documentation

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

## Features

Expand All @@ -27,8 +27,8 @@ The documentation of API Platform's Client Generator can be browsed [on the offi
* Creation form
* Editing form
* Deletion button
* Use the Hydra or OpenAPI documentations to generate the code
* Generate the suitable HTML5 input type (`number`, `date`...) according to the type of the API property
* 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
Expand All @@ -38,16 +38,16 @@ The documentation of API Platform's Client Generator can be browsed [on the offi

### Hydra

npx @api-platform/client-generator https://demo.api-platform.com/ output/ --resource Book
pnpm create @api-platform/client https://demo.api-platform.com/ output/ --resource Book

### OpenAPI 3

npx @api-platform/client-generator https://demo.api-platform.com/docs.json output/ --resource Book --format openapi3
pnpm create @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 available upon request.
Commercial support is available upon request.
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@api-platform/client-generator",
"name": "@api-platform/create-client",
"version": "0.8.0",
"description": "Generate apps built with Next, Nuxt, Quasar, React, React Native, Vue or Vuetify for any API documented using Hydra or OpenAPI",
"files": [
Expand All @@ -11,9 +11,9 @@
],
"type": "module",
"exports": "./lib/index.js",
"repository": "api-platform/client-generator",
"homepage": "https://github.com/api-platform/client-generator",
"bugs": "https://github.com/api-platform/client-generator/issues",
"repository": "api-platform/create-client",
"homepage": "https://github.com/api-platform/create-client",
"bugs": "https://github.com/api-platform/create-client/issues",
"author": "Kévin Dunglas",
"license": "MIT",
"devDependencies": {
Expand Down