Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jmoussa/chat-app-be
Backend for the Chat Application FE repository. A chat room application, that utilizes Python's FastAPI, WebSockets and MongoDB for persistence.
https://github.com/jmoussa/chat-app-be
backend chat chat-room fastapi mongodb python python-fastapi-websockets webservice websocket-connection websockets
Last synced: about 1 month ago
JSON representation
Backend for the Chat Application FE repository. A chat room application, that utilizes Python's FastAPI, WebSockets and MongoDB for persistence.
- Host: GitHub
- URL: https://github.com/jmoussa/chat-app-be
- Owner: jmoussa
- Created: 2020-05-05T02:59:25.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-04-25T05:56:44.000Z (8 months ago)
- Last Synced: 2024-04-25T06:43:09.854Z (8 months ago)
- Topics: backend, chat, chat-room, fastapi, mongodb, python, python-fastapi-websockets, webservice, websocket-connection, websockets
- Language: Python
- Homepage:
- Size: 333 KB
- Stars: 54
- Watchers: 1
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Chat Room App
This API was built to support the [chat_app_FE](https://github.com/jmoussa/chat_app_FE).
In the `/api` folder you will find the routes for rooms and users.
This being a FastAPI app, you will also be able to get quick documenatation on the routes and request types after getting it up and running.
This app uses:
- Anaconda (for Python environemnt management)
- Python FastAPI+WebSockets [docs](https://fastapi.tiangolo.com/)
- Pymongo [docs](https://pymongo.readthedocs.io/en/stable/)
- MongoDB [docs](https://docs.mongodb.com/manual/)
- AWS S3 (image handling)
- Twilio (video chat)
## Setting up and running
I've set it up so that you only need to use the `run` script to start.
Be sure to set the S3 environement variables for access
```bash
conda env create -f environment.yml
conda activate chat_app
export AWS_SECRET_ACCESS_KEY=...
export AWS_ACCESS_KEY_ID=...
cp config.template.py config.py # edit config.py and fill with your values/credentials
./run
```
_For quick API documentation, navigate to `localhost:8000/docs` after starting the server_
## Dependencies
This app uses a couple of 3rd party resources for all of it's functionality.
- AWS S3 is used for storing the user's profile images and fetching them.
- Twilio is used for the group video chat capability.
- MongoDB is used to persist all data to the database.
## Screenshots
