https://github.com/buuntu/fastapi-chat
Chat Application using FastAPI and WebSockets
https://github.com/buuntu/fastapi-chat
Last synced: about 1 year ago
JSON representation
Chat Application using FastAPI and WebSockets
- Host: GitHub
- URL: https://github.com/buuntu/fastapi-chat
- Owner: Buuntu
- Created: 2020-03-25T20:36:44.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-06-01T23:57:28.000Z (about 4 years ago)
- Last Synced: 2025-03-28T03:51:12.037Z (about 1 year ago)
- Language: TypeScript
- Size: 52.7 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FastAPI Chat
An example chat application using FastAPI, React, and WebSockets.
It uses no persistence so all of the chat information is stored in
memory. However postgres is configured as a docker container so should
be easy to add persistence.
## Features
- **FastAPI** with Python 3.8
- **React 16** with Typescript, Redux, and react-router
## Development
The only dependencies for this project should be docker and docker-compose.
### Quick Start
Starting the project with hot-reloading enabled
(the first time it will take a while):
```
docker-compose up -d
```
- Backend will be at http://localhost:8888
- Auto-generated docs at
http://localhost:8888/docs
- Frontend at http://localhost:8000
### Frontend Development
Alternatively to running inside docker, it can sometimes be easier
to use npm directly for quicker reloading. To run using npm:
```
cd frontend
npm install
npm start
```
This should redirect you to http://localhost:3000
## Testing
```
docker-compose run backend pytest
```
## Logging
```
docker-compose logs
```
Or for a specific service:
```
docker-compose logs -f name_of_service # frontend|backend|db
```