chore: updated readme

main
Antonio De Lucreziis 11 months ago
parent e87a9bef18
commit 3083dc5f18

@ -8,8 +8,11 @@ Continuous Deployment for PHC projects.
# First install the dependencies # First install the dependencies
$ pnpm install $ pnpm install
# Run the app # Run the local server
$ pnpm run dev $ pnpm dev
# Build all
$ pnpm build
``` ```
## Architecture ## Architecture
@ -20,7 +23,9 @@ Everything is stored in the `config.yaml` file. This file contains a list of pro
deploys: deploys:
- name: project1 - name: project1
url: https://github.com/username/project1 url: https://github.com/username/project1
branch: main ref:
type: branch
value: main
type: dockerfile type: dockerfile
options: options:
ports: ports:
@ -29,7 +34,9 @@ deploys:
- /var/www/html:/var/www/html - /var/www/html:/var/www/html
- name: project2 - name: project2
url: ssh://example.org/username/project2.git url: ssh://example.org/username/project2.git
commit: 04c540647a ref:
type: commit
value: '1234567'
type: docker-compose type: docker-compose
options: options:
path: ./docker-compose.yml # already the default path: ./docker-compose.yml # already the default
@ -39,3 +46,4 @@ deploys:
options: options:
path: ./deploy.sh # already the default path: ./deploy.sh # already the default
``` ```

Loading…
Cancel
Save