- Install Docker
- Install npm
- Install yarn
- Clone this project:
$ git clone https://github.com/marydn/star-wars - Move to the project folder:
$ cd star-wars - Generate assets:
$ yarn install && yarn build
-
By default, Redis TTL is set to 300 seconds.
To override this parameter:
$ touch .env.local $ echo 'REDIS_TTL=XXX' >> .env.local # where XXX is the desired int value
-
Start the project:
$ make buildThis will install PHP dependencies and bring up the project Docker containers with Docker Compose.
-
Check everything's up:
$ docker-composer psIt should show nginx and php services up.
-
Go to
http:://localhost:8000in your browser
- Bringing up the project using Docker:
$ make - Bringing down the project:
$ make destroy - Rebuild Docker images forcing latest versions and ignoring cache:
$ make rebuild
- Install PHP dependencies if you haven't done so:
$ make deps - Execute PHP Unit tests:
$ make test
It's a simple form that let you query an endpoint and print the result into a table using XMLHttRequest.
Every request made is cached in Redis using a Middleware (src/Service/Middleware/CachedMiddleware.php)
$ tree -L 4 src
src
├── Controller
│ ├── HomeController.php
│ └── JsonController.php
├── Public
│ ├── js
│ │ └── entry.js # This is for webpack
│ └── vue
│ └── ApiFetcher.vue # Javascript component for front
└── Service
├── ApiConsumer.php # Service to wrap third-party requests
├── Middleware
│ └── CachedMiddleware.php # Middleware that allows to call a cache wrapper per API call
├── Normalizer
│ └── GuzzleResponseNormalizer.php # Normalize Guzzle Response Objects to save and retrieve to/from Redis
└── RedisCache.php # Some methods to handle Redis transactions