Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: add a reference to template-sync tool #1849

Open
wants to merge 1 commit into
base: 3.2
Choose a base branch
from
Open

docs: add a reference to template-sync tool #1849

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions distribution/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,20 @@ Of course, you can also use your favorite HTTP client to query the API.
We are fond of [Postman](https://www.getpostman.com/). It works perfectly well with API Platform, has native OpenAPI support,
allows to easily write functional tests and has good team collaboration features.

## Update Your Project

You have started a project with the API Platform template and you would like to benefit from the latest enhancements introduced since you created your project (i.e. [FrankenPHP](https://frankenphp.dev/). Juste use this git based tool
[The *template-sync* project](https://github.com/coopTilleuls/template-sync) got you covered.

Run the following command to import the changes since your last update:

```console
curl -sSL https://raw.githubusercontent.com/mano-lis/template-sync/main/template-sync.sh | sh -s -- https://github.com/api-platform/api-platform
```
Resolve potential conflicts, run `git cherry-pick --continue` and you are done!

[Full documentation](https://github.com/coopTilleuls/template-sync/blob/main/README.md)

## Bringing your Own Model

Your API Platform project is now 100% functional. Let's expose our own data model.
Expand Down