wlinator/tux
1
Fork 0
mirror of https://github.com/allthingslinux/tux.git synced 2024-10-02 16:43:12 +00:00
Code Issues Releases Wiki Activity

refactor: Update README to provide more info about Docker Compose hot reloading

Browse source
This commit is contained in:
wlinator 2024-09-02 11:53:40 -04:00
parent 5fb58c274a
commit 7038da4c45
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -58,7 +58,7 @@ It is designed to provide a variety of features to the server, including moderat
- [Poetry](https://python-poetry.org/docs/)
- [Supabase](https://supabase.io/)
- Optional: [Docker](https://docs.docker.com/get-docker/)
- Optional: [Docker Compose](https://docs.docker.com/compose/install/)
- Optional: [Docker Compose](https://docs.docker.com/compose/install/) (see the [development notes](#development-notes) for more information)
- Optional: [Just](https://github.com/casey/just/)
### Steps to Install
@ -141,6 +141,9 @@ Make sure to add your discord ID to the sys admin list if you are testing locall
> [!NOTE]
Make sure to set the prisma schema database ENV variable to the DEV database URL.
> [!NOTE]
If you want to develop Tux using Docker Compose, we recommend using `docker compose up --watch` for hot reloading.
## License
This project is licensed under the terms of the The GNU General Public License v3.0.