Skip to content

Commit f92c89e

Browse files
committed
Update README.md
1 parent 2493392 commit f92c89e

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ This template provides out of the box some commonly used functionalities:
2222

2323
* Sync and Async API Documentation using [FastAPI](https://fastapi.tiangolo.com/) and [AsyncAPI](https://www.asyncapi.com/en)
2424
* Async tasks execution using [Dramatiq](https://dramatiq.io/index.html)
25+
* Websocket application using [Socket.io](https://python-socketio.readthedocs.io/en/stable/index.html)
2526
* Repository pattern for databases using [SQLAlchemy](https://www.sqlalchemy.org/) and [SQLAlchemy bind manager](https://febus982.github.io/sqlalchemy-bind-manager/stable/)
2627
* Database migrations using [Alembic](https://alembic.sqlalchemy.org/en/latest/) (configured supporting both sync and async SQLAlchemy engines)
2728
* Database fixtures support using customized [Alembic](https://alembic.sqlalchemy.org/en/latest/) configuration
@@ -50,7 +51,8 @@ Using Docker:
5051

5152
* `make containers`: Build containers
5253
* `docker compose run --rm dev make migrate`: Run database migrations
53-
* `docker compose up dev`: Run HTTP application with hot reload
54+
* `docker compose up dev-http`: Run HTTP application with hot reload
55+
* `docker compose up dev-socketio`: Run HTTP application with hot reload
5456
* `docker compose up dramatiq-worker`: Run the dramatiq worker
5557
* `docker compose run --rm test`: Run test suite
5658

@@ -61,7 +63,8 @@ Locally:
6163
* `make dev-dependencies`: Install dev requirements
6264
* `make update-dependencies`: Updates requirements
6365
* `make migrate`: Run database migrations
64-
* `make dev`: Run HTTP application with hot reload
66+
* `make dev-http`: Run HTTP application with hot reload
67+
* `make dev-socketio`: Run HTTP application with hot reload
6568
* `make test`: Run test suite
6669

6770
## Other commands for development

0 commit comments

Comments
 (0)