Skip to content
This repository was archived by the owner on Dec 11, 2023. It is now read-only.

Commit ff58e7f

Browse files
authored
Merge pull request #8 from danitome24/improve-readme
Improved readme
2 parents 7da8283 + 499de3f commit ff58e7f

File tree

1 file changed

+39
-6
lines changed

1 file changed

+39
-6
lines changed

README.md

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,45 @@
1-
# DDD php Skeleton
1+
<p align="center">
2+
<a href="http://codely.tv">
3+
<img src="http://codely.tv/wp-content/uploads/2016/05/cropped-logo-codelyTV.png" width="192px" height="192px"/>
4+
</a>
5+
</p>
6+
7+
<p align="center">Template to start from scratch a new Php project using DDD as architecture.</p>
28

39
## Installation
410

5-
`composer create-project codelytv/ddd-skeleton`
11+
Use the dependency manager [Composer](https://getcomposer.org/) to create a new project.
12+
13+
```
14+
composer create-project codelytv/ddd-skeleton
15+
```
16+
17+
## Usage with Docker
18+
19+
Just run:
20+
21+
```
22+
make build
23+
```
24+
25+
Then go to `http://localhost:8030/health-check` to check all is ok.
626

7-
## Starting the server
8-
* Local using: `make start-local`
9-
* First you should execute `make prepare-local`
10-
* Docker using: `make build`
27+
## Usage from local
28+
29+
First of all you should execute
30+
31+
```
32+
make prepare-local
33+
```
34+
35+
And then start local environment:
36+
37+
```
38+
make start-local
39+
```
1140

1241
And then going to `http://localhost:8030/health-check` to check all is ok.
42+
43+
## Contributing
44+
There are some things missing feel free to add this if you want! If you want
45+
some guidelines feel free to contact us :)

0 commit comments

Comments
 (0)