Skip to content

Commit a1bf55a

Browse files
committed
Merge branch '2.3'
2 parents 4233042 + 735b43c commit a1bf55a

File tree

3 files changed

+12
-9
lines changed

3 files changed

+12
-9
lines changed

client-generator/vuejs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ import App from './App.vue';
4141

4242
// Replace "foo" with the name of the resource type
4343
import foo from './store/modules/foo/';
44-
import fooRoutes from './routes/foo';
44+
import fooRoutes from './router/foo';
4545

4646
Vue.use(Vuex);
4747
Vue.use(VueRouter);

distribution/index.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,13 @@ it.
6666
API Platform is shipped with a [Docker](https://docker.com) setup that makes it easy to get a containerized development
6767
environment up and running. If you do not already have Docker on your computer, [it's the right time to install it](https://docs.docker.com/install/).
6868

69+
On Mac, only [Docker for Mac](https://docs.docker.com/docker-for-mac/) is supported.
70+
Similarly, on Windows, only [Docker for Windows](https://docs.docker.com/docker-for-windows/) is supported. Docker Machine **is not** supported out of the box.
71+
6972
Open a terminal, and navigate to the directory containing your project skeleton. Run the following command to start all
7073
services using [Docker Compose](https://docs.docker.com/compose/):
7174

75+
$ docker-compose pull # Download the latest versions of the pre-built images
7276
$ docker-compose up -d # Running in detached mode
7377

7478
This starts the following services:
@@ -83,11 +87,6 @@ This starts the following services:
8387
| cache-proxy | A HTTP cache proxy for the API provided by Varnish | 8081 | all (prefer using a managed service in prod)
8488
| h2-proxy | A HTTP/2 and HTTPS development proxy for all apps | 443 (client)<br>444 (admin)<br>8443 (api)<br>8444 (cache-proxy) | dev (configure properly your web server in prod)
8589

86-
If you encounter problems running Docker on Windows (especially with Docker Toolbox), see [our Troubleshooting guide](../extra/troubleshooting.md#using-docker).
87-
88-
The first time you start the containers, Docker downloads and builds images for you. It will take some time, but don't worry,
89-
this is done only once. Starting servers will then be lightning fast.
90-
9190
To see the container's logs, run:
9291

9392
$ docker-compose logs -f # follow the logs
@@ -151,7 +150,7 @@ And start the built-in PHP server or the Symfony WebServerBundle:
151150
All JavaScript components are also [available as standalone libraries](https://github.com/api-platform?language=javascript)
152151
installable with NPM or Yarn.
153152

154-
**Note:** when installing API Platform this way, the API will be exposed as the `/api/` path. You need to open `http://localhost:8000/api/` to see the API documentation.
153+
**Note:** when installing API Platform this way, the API will be exposed as the `/api/` path. You need to open `http://localhost:8000/api/` to see the API documentation. If you are deploying API Platform directly on an Apache or Nginx webserver and getting a 404 error on opening this link, you will need to enable the [rewriting rules](https://symfony.com/doc/current/setup/web_server_configuration.html) for your specific webserver software.
155154

156155
## It's Ready!
157156

@@ -647,7 +646,7 @@ Isn't API Platform a REST **and** GraphQL framework? That's true! GraphQL suppor
647646
need to install the [graphql-php](https://webonyx.github.io/graphql-php/) library. Run the following command (the cache needs to be cleared twice):
648647

649648
```bash
650-
docker-compose exec php composer req webonyx/graphql-php && bin/console cache:clear
649+
docker-compose exec php composer req webonyx/graphql-php && docker-compose exec php bin/console cache:clear
651650
```
652651

653652
You now have a GraphQL API! Open `https://localhost:8443/graphql` to play with it using the nice [GraphiQL](https://github.com/graphql/graphiql)

distribution/testing.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,10 @@ You may also be interested in these alternative testing tools (not included in t
185185

186186
## Running Unit Tests with PHPUnit
187187

188+
To install [PHPUnit](https://phpunit.de/) test suite, execute the following command:
189+
190+
$ docker-compose exec php composer require --dev symfony/phpunit-bridge
191+
188192
To run your [PHPUnit](https://phpunit.de/) test suite, execute the following command:
189193

190-
$ docker-compose exec php vendor/bin/phpunit
194+
$ docker-compose exec php bin/phpunit

0 commit comments

Comments
 (0)