Merge pull request 'Add running instructions to readme and fix Makefile' (#2) from chore/make-public into master

Reviewed-on: #2

.env.example

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

.gitea/workflows/ci.yml

@@ -23,12 +23,23 @@ jobs:
       - name: Validate composer.json
         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
         id: composer-cache
         uses: actions/cache@v4
         with:
           path: vendor
-          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.json') }}
+          key: ${{ runner.os }}-php-${{ steps.get-hash.outputs.hash }}
           restore-keys: |
             ${{ runner.os }}-php-
 

Makefile

@@ -1,15 +1,17 @@
-EXEC="docker compose exec php"
-
 up:
 	docker compose up -d
 
 start: up composer-install
 
+composer-install:
+	docker compose exec -T php composer install
 stop:
 	docker compose stop
 cmd:
-	"$(EXEC)" sh 
+	docker compose exec php sh 
 phpstan:
-	"$(EXEC)" vendor/bin/phpstan analyse src --level 8
+	docker compose exec -T php vendor/bin/phpstan analyse src --level 8
 cs-fix:
-	"$(EXEC)" vendor/bin/php-cs-fixer fix --allow-risky=yes
+	docker compose exec -T php vendor/bin/php-cs-fixer fix --allow-risky=yes
+test:
+	docker compose exec -T php vendor/bin/pest

README.md

@@ -0,0 +1,20 @@
+# Armel.net
+
+### How to run
+
+```
+cp .env.example .env
+make start
+```
+
+You will now have a webserver running on localhost:443 and localhost:80
+
+### How to stop
+```
+make stop
+```
+
+### How to test
+```
+make test
+```