Skip to content

ade555/WhisperTime

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WhisperTime (WIP)

Introduction

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.

Table of Contents

Getting Started

The following instructions will help you install WhisperTime on your local system and have it running.

Prerequisites

  • Python 3.10 or higher

Installation and Setup

  1. Clone the repository
git clone https://github.com/ade555/WhisperTime.git
  1. Change directory to the project folder
cd WhisperTime
  1. Create a virtual environment
python -m venv env
  1. Install the project dependencies into your virtual environment
pip install -r requirements.txt
  1. Generate a new secret key
python secret_key.py
  1. Create an environment variable (.env file) and include the necessary information from the .env_sample file

  2. Open your CLI and start the project

python manage.py runserer

Testing

Technologies and Tools

  • Python - The programming language used
  • JWT - JSON Web Tokens for authentication

Contributing

Contributions are welcome! Feel free to open a pull request right away.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages