Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit a04e09a

Browse files
author
José Fernando Cordova
committed
Merge remote-tracking branch 'origin/feature/refactoring' into develop
2 parents bf0ce36 + 18a5a3e commit a04e09a

File tree

1 file changed

+28
-7
lines changed

1 file changed

+28
-7
lines changed

‎README.md

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,28 @@
99
* Xdebug
1010
* Docker
1111

12-
## Environments
12+
You can manage a RestFull API in the fastest, simplest and funniest way! and with open source code dependencies.
13+
14+
However you can contribute for a better performance, the goal is to focus on the code avoiding the configurations and having docker installed.
15+
16+
### Prerequisites
1317

14-
To deploy this api boilerplate, there are three options (yaml) and Docker environments with instructions that you should consider:
18+
* [Docker](https://docs.docker.com/install/)
19+
* [Docker Compose](https://docs.docker.com/compose/install/)
20+
21+
## Environments
1522

1623
### Dev or Local Mode
17-
* docker-compose-dev.yml: generate automatically folders and require-dev dependencies on your local workspace including Xdebug, however the yaml file has a key called:
18-
"XDEBUG_MODE", this yaml by default has the value true (1) to install it.
24+
* docker-compose-dev.yml: generate automatically folders and require-dev dependencies on your local workspace including Xdebug.
25+
Note: the yaml file has a key called:"XDEBUG_MODE", this yaml by default has the value true (1) to install it.
1926

2027
You can appreciate the dependencies generated automatically on your workspace!
2128

2229
### Play with Docker Mode
23-
* docker-compose-pwd.yml: you can [![Play With Docker](https://cdn.rawgit.com/play-with-docker/stacks/cff22438/assets/images/button.png)](http://play-with-docker.com?stack=https://raw.githubusercontent.com/jfernancordova/docker-laravel-api-dev/feature/refactoring/docker-compose-pwd.yml), to visualize this environment and test it, however you should see the container lists to verify the HEALTHCHECK.
30+
31+
[![Play With Docker](https://cdn.rawgit.com/play-with-docker/stacks/cff22438/assets/images/button.png)](http://play-with-docker.com?stack=https://raw.githubusercontent.com/jfernancordova/docker-laravel-api-dev/feature/refactoring/docker-compose-pwd.yml)
32+
33+
* docker-compose-pwd.yml: you can use it to visualize this environment and test it, however you should see the container lists to verify the HEALTHCHECK.
2434

2535
```bash
2636
# container lists
@@ -29,9 +39,13 @@ docker ps
2939
normally the process begins in starting mode (health: starting),
3040
```
3141
### Production Mode
32-
* docker-compose-prod.yml: if you are going to use this yaml, make sure to generate the migrations before!, however you can modify the entrypoint to generate them.
42+
* docker-compose-prod.yml: if you are going to use this yaml, make sure to generate the migrations before!,you can modify the entrypoint to generate them.
43+
44+
## Deployment
45+
46+
### Docker Environments
3347

34-
## Docker Environments
48+
Clone this respository and run the following commands based on your orchestrator;
3549

3650
### Swarm Mode
3751
Clone this respository and run the following commands:
@@ -50,6 +64,13 @@ or to see the logs
5064
docker-compose -f docker-compose-dev.yml up
5165
# wait for the HEALTHCHECK in healthy mode
5266
```
67+
## Running the tests
68+
69+
You have a [Travis](https://travis-ci.org/) Pipeline to apply Continous Integration, and other technology to test this environment.
70+
71+
You can modify the runtests.sh from the [scripts folder](https://raw.githubusercontent.com/jfernancordova/docker-laravel-api-dev/master/scripts/runtests.sh)
72+
73+
Insert jobs, instructions, builds in [this pipeline](https://raw.githubusercontent.com/jfernancordova/docker-laravel-api-dev/master/.travis.yml)
5374

5475
## API Boilerplate Reference
5576
https://github.com/francescomalatesta/laravel-api-boilerplate-jwt/blob/master/readme.md

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /