Add startup instructions #1

Merged
armel merged 1 commits from chore/readme into master 2024-08-30 23:29:35 +02:00
4 changed files with 35 additions and 1 deletions
Showing only changes of commit f2273a0cdb - Show all commits

1
.env.example Normal file
View File

@@ -0,0 +1 @@
ENVIRONMENT=development

View File

@@ -23,12 +23,23 @@ jobs:
- name: Validate composer.json - name: Validate composer.json
run: composer validate run: composer validate
- uses: actions/setup-go@v3
with:
go-version: '1.20'
- uses: https://gitea.com/actions/go-hashfiles@v0.0.1
id: get-hash
with:
patterns: |-
go.sum
**/composer.json
- name: Cache Composer packages - name: Cache Composer packages
id: composer-cache id: composer-cache
uses: actions/cache@v4 uses: actions/cache@v4
with: with:
path: vendor path: vendor
key: ${{ runner.os }}-php-${{ hashFiles('**/composer.json') }} key: ${{ runner.os }}-php-${{ steps.get-hash.outputs.hash }}
restore-keys: | restore-keys: |
${{ runner.os }}-php- ${{ runner.os }}-php-

View File

@@ -5,6 +5,8 @@ up:
start: up composer-install start: up composer-install
composer-install:
"$(EXEC)" composer install
stop: stop:
docker compose stop docker compose stop
cmd: cmd:
@@ -13,3 +15,5 @@ phpstan:
"$(EXEC)" vendor/bin/phpstan analyse src --level 8 "$(EXEC)" vendor/bin/phpstan analyse src --level 8
cs-fix: cs-fix:
"$(EXEC)" vendor/bin/php-cs-fixer fix --allow-risky=yes "$(EXEC)" vendor/bin/php-cs-fixer fix --allow-risky=yes
test:
"$(EXEC)" vendor/bin/pest

View File

@@ -0,0 +1,18 @@
# Armel.net
### How to run
```
cp .env.example .env
make start
```
### How to stop
```
make stop
```
### How to test
```
make test
```