Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
GianlucaFicarelli committed Jun 13, 2024
1 parent 2c3c6fe commit 85f760b
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 13 deletions.
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ HELP_TEMPLATE := \033[36m%-23s\033[0m %s
help: ## Show this help
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "$(HELP_TEMPLATE)\n", $$1, $$2}'

install: ## Install dependencies into .venv
pdm install --no-self

compile-deps: ## Create or update the lock file, without upgrading the version of the dependencies
pdm lock

Expand All @@ -16,9 +19,6 @@ upgrade-deps: ## Create or update the lock file, using the latest version of th
check-deps: ## Check that the dependencies in the existing lock file are valid
pdm lock --check

install: ## Install dependencies into .venv
pdm install --no-self

format: # Run formatters
pdm run ruff format
pdm run ruff check --fix
Expand Down
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,23 @@ Valid `make` targets:

```
help Show this help
build-image Build the local docker images
run-image Run the local docker images
compile-deps Create or update requirements.txt, without upgrading the version of the dependencies
upgrade-deps Create or update requirements.txt, using the latest version of the dependencies
check-deps Check that the dependencies in the existing requirements.txt are valid
py Run tests and coverage
lint Check linting
format Format the code
version Print the version
install Install dependencies into .venv
compile-deps Create or update the lock file, without upgrading the version of the dependencies
upgrade-deps Create or update the lock file, using the latest version of the dependencies
check-deps Check that the dependencies in the existing lock file are valid
lint Run linters
build Build the local docker images
run Run the application in docker
kill Take down the application
tests Run tests in the app container
migration Create the alembic migration
sh Run a shell in the app container
```

To build and start the Docker images locally, you can execute:

```bash
make run-image
make run
```


Expand Down

0 comments on commit 85f760b

Please sign in to comment.