simplechat/README.md

37 lines
727 B
Markdown

# Simple Chat
This is a simple one-room chat application with user management, developed as a school project for study purposes.
**Not recommended for production use.**
A test protocol can be found here: [simple_chat_testprotokoll.pdf](simple_chat_testprotokoll.pdf)
## Running with Docker
```sh
docker compose -f docker/compose.yml up
```
### Running in Development Mode
With Docker:
```sh
BUILD_TARGET=dev docker compose -f docker/compose.yml
```
Then, install dependencies for the frontend and start the development server:
```sh
cd frontend
npm install
npm run dev
```
For the backend, install dependencies and run the server:
```sh
pip install -r simple_chat_api/requirements.txt
python -m simple_chat_api
```