https://github.com/harry-urek/room
ROOM - redis cached chat application based on Session concepts
https://github.com/harry-urek/room
celery celery-redis fastapi postgresql python redis sqlalchemy websocket
Last synced: 2 months ago
JSON representation
ROOM - redis cached chat application based on Session concepts
- Host: GitHub
- URL: https://github.com/harry-urek/room
- Owner: harry-urek
- Created: 2023-10-01T20:28:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-26T14:52:48.000Z (almost 2 years ago)
- Last Synced: 2025-06-06T06:02:14.115Z (about 1 year ago)
- Topics: celery, celery-redis, fastapi, postgresql, python, redis, sqlalchemy, websocket
- Language: Python
- Homepage:
- Size: 25.7 MB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ROOM
ROOM is built with FASTAPI, Celery, Redis, and PostgreSQL. It is designed to for fast and secure chat application made with room session message concept.
## Table of Contents
- [ROOM](#room)
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Getting Started](#getting-started)
## Features
- [List key features and functionalities of your project]
## Prerequisites
Before you begin, ensure you have met the following requirements:
- [List the prerequisites and dependencies needed to run your project]
- [E.g., Python 3.x, Docker, etc.]
## Getting Started
Follow these steps to get your project up and running:
1. Clone the repository:
```bash
git clone https://github.com/yourusername/room.git
```
2. Install project dependencies:
```bash
Copy code
pip install -r requirements.txt
```
[Any additional setup steps if required]
3. Run the project:
```bash
Copy code
uvicorn main:app --host 0.0.0.0 --port 8000 --reload
```
Open your web browser and navigate to http://localhost:8000 to access the application.
4. Configuration
[Explain how to configure your project, including environment variables and configuration files]
5. Deployment
Using Docker
Build the Docker image:
```bash
Copy code
docker build -t room-app .
```
Run the Docker container:
```bash
Copy code
docker run -d -p 8000:8000 room-app
```
[Include any additional deployment methods, e.g., using Docker Compose, Kubernetes, etc.]
-API Documentation
[Provide information on how to access the API documentation, e.g., Swagger or ReDoc]
API documentation is available at http://localhost:8000/docs.
Contributing
[Explain how others can contribute to your project, including guidelines and code of conduct]
License
This project is licensed under the [License Name] License - see the LICENSE.md file for details.
Feel free to customize this template to match the specifics of your project. You should provide detailed information on how to install, configure, and run your project, as well as how to contribute and access API documentation. Also, don't forget to include a license file (e.g., LICENSE.md) and specify the license used in your project.