WhisperTime is an MVP API for chat applications created with Django Rest Framework and Redis. Some of its features include email authentication, user management and real-time messaging. With WhisperTime, developers can easily integrate secure and efficient chat functionality into their applications without having to build everything from scratch.
In addition to basic chat functionality, WhisperTime offers real-time messaging, allowing users to send and receive messages instantly. The API leverages Redis, a high-performance in-memory data store, to enable lightning-fast message delivery and ensure a seamless chat experience even under high loads.
The following instructions will help you install WhisperTime on your local system and have it running.
- Python 3.10 or higher
- Clone the repository
git clone https://github.com/ade555/WhisperTime.git
- Change directory to the project folder
cd WhisperTime
- Create a virtual environment
python -m venv env
- Install the project dependencies into your virtual environment
pip install -r requirements.txt
- Generate a new secret key
python secret_key.py
-
Create an environment variable (
.env
file) and include the necessary information from the.env_sample
file -
Open your CLI and start the project
python manage.py runserer
Contributions are welcome! Feel free to open a pull request right away.
This project is licensed under the MIT License - see the LICENSE.md file for details