Merge pull request 'docs: add optional watchexec command to README.md' (!95) from add-some-docs into main
Reviewed-on: #95 Reviewed-by: Phan Huy Tran <ptran@noreply.localhost>
This commit is contained in:
commit
4f6add087b
1 changed files with 6 additions and 1 deletions
|
@ -67,6 +67,11 @@ cd backend
|
||||||
./gradlew bootRun
|
./gradlew bootRun
|
||||||
```
|
```
|
||||||
|
|
||||||
|
You may optionally install [watchexec](https://github.com/watchexec/watchexec?tab=readme-ov-file) and use this command to autorecompile the backend on file changes:
|
||||||
|
```bash
|
||||||
|
watchexec -r -e java ./gradlew :bootRun
|
||||||
|
```
|
||||||
|
|
||||||
The backend will be available at:
|
The backend will be available at:
|
||||||
- API endpoint: http://localhost:8080
|
- API endpoint: http://localhost:8080
|
||||||
- Swagger documentation: http://localhost:8080/swagger
|
- Swagger documentation: http://localhost:8080/swagger
|
||||||
|
@ -164,4 +169,4 @@ References:
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||||
|
|
Reference in a new issue