Skip to content

Commit 98095d3

Browse files
committed
refactor: added help command on Makefile
1 parent 9119d44 commit 98095d3

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

Makefile

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
help:
2+
@echo "Available commands:"
3+
@echo " run Start app and services using Docker."
4+
@echo " stop-all Stop all services running on Docker."
5+
@echo " remove Remove all Docker containers."
6+
@echo " clean Remove temporary and cache files."
7+
18
run:
29
docker compose up -d
310

@@ -7,5 +14,8 @@ build:
714
stop-all:
815
docker compose stop $(docker ps -q)
916

17+
remove:
18+
docker compose down
19+
1020
clean:
11-
rm -rf node_modules/ uploads/*.pdf
21+
rm -rf node_modules/ uploads/*.pdf

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,12 +84,10 @@ cp .env.example .env
8484
> From the app's root directory, run the following command to build and running docker containers:
8585

8686
```shell
87-
make build
88-
# or
8987
make run
9088
```
9189

92-
> The application will be available at `http://localhost:3000`.<br>For more commands see `Makefile`.
90+
> The application will be available at `http://localhost:3000`.<br>For more commands see `Makefile` or run `make help`.
9391

9492
## Documentation
9593

0 commit comments

Comments
 (0)