42 lines
908 B
Markdown
42 lines
908 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](docs/simple_chat_testprotokoll.pdf)
|
|
|
|
A Project overview can be found here: [Perplexity overview](docs/project_overview.md)
|
|
|
|
## 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
|
|
DEV=true python -m simple_chat_api
|
|
```
|
|
|
|
To run tests:
|
|
`python -m unittest discover -s simple_chat_api/tests -p "*.py"`
|