https://github.com/degisew/hubspot

A real-time chat application using Django and Python, inspired by Discord. This project aims to replicate some of the key features of Discord, allowing users to create and join chat rooms, send and receive messages in real-time, and manage user accounts. Implemented features such as text messaging, user authentication, roles, and permissions.
https://github.com/degisew/hubspot

bootstrap css3 django django-rest-framework html5 postgresql python3

Last synced: 3 months ago
JSON representation

A real-time chat application using Django and Python, inspired by Discord. This project aims to replicate some of the key features of Discord, allowing users to create and join chat rooms, send and receive messages in real-time, and manage user accounts. Implemented features such as text messaging, user authentication, roles, and permissions.

• Host: GitHub
• URL: https://github.com/degisew/hubspot
• Owner: degisew
• License: mit
• Created: 2023-04-30T14:56:21.000Z (about 3 years ago)
• Default Branch: dev
• Last Pushed: 2024-01-31T18:43:44.000Z (over 2 years ago)
• Last Synced: 2024-04-16T02:17:31.441Z (about 2 years ago)
• Topics: bootstrap, css3, django, django-rest-framework, html5, postgresql, python3
• Language: HTML
• Homepage:
• Size: 22 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# HubSpot



**A scalable event ticket booking platform built with modern backend technologies**

[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)

[![Python](https://img.shields.io/badge/Python-3.12+-blue.svg)](https://python.org)

[![Django](https://img.shields.io/badge/Django-5.x-green.svg)](https://djangoproject.com)

[![Docker](https://img.shields.io/badge/Docker-20.10+-blue.svg)](https://docker.com)

**Contact**: [degisew.mengist21@gmail.com](mailto:degisew.mengist21@gmail.com) | [LinkedIn](https://linkedin.com/in/degisew-mengist)



## Overview

A structured real-time chat platform that allows users to join or create rooms based on discussion topics. It aims to provide a clean, organized environment for topic-focused communication with user-friendly features. While core features are in place, development is ongoing to enhance functionality and user experience.

**Key Features**:

- Real-time messaging across user-created rooms.

- Topic-based room organization for focused discussions.

- User registration, login, and profile management.

- Room and message permissions (owner/moderator roles planned).

- Containerized deployment with Docker.

## Table of Contents

- [Overview](#overview)

- [Quick Start](#quick-start)

- [Project Structure](#project-structure)

- [Setup](#setup)

- [Architecture](#architecture)

  

- [Deployment](#deployment)

## Quick Start

```bash

# Clone the repo

git clone https://github.com/degisew/HubSpot.git

cd HubSpot

# Run with Docker

docker-compose up --build

# OR run locally

python -m venv venv

source venv/bin/activate  # Windows: venv\Scripts\activate

pip install -r requirements/dev.txt

python manage.py runserver

```

**Access**: [http://localhost:8000](http://localhost:8000) for Landing page.

## Project Structure

```bash

├── apps/                 # Custom Apps collection

├── config/               # Project Configurations

├── docker

│     └── dev/

│          └── Dockerfile # Django API Dockerfile for development environment

├── tests/                 # automated tests

├── requirements/         # requirements.txt files collection

├── .env                  # Environment variables (you will create this)

├── compose.yaml          # Docker Compose configuration file

└── README.md             # This README file

```

## Setup

Show Setup Details

### Prerequisites

- Python 3.10+

- Docker 20.10+ & Docker Compose 1.29+

- PostgreSQL 14+ (for local setup)

- Git 2.30+

### Instructions

1. **Clone the Repository**:

   ```bash

   git clone https://github.com/degisew/HubSpot.git

   cd HubSpot

   ```

2. **Configure Environment**:

   ```bash

   Create a .env file with-in your root project directory and store secure values.

   ```

   Example `.env`:

   ```bash

   # Database

   POSTGRES_USER=your_db_user

   POSTGRES_PASSWORD=your_db_password

   POSTGRES_DB=your_db_name

   # FastAPI

   SECRET_KEY=your_secret_key

   DB_USER=your_database_user

   # Optional: pgAdmin

   PGADMIN_DEFAULT_EMAIL=admin@example.com

   PGADMIN_DEFAULT_PASSWORD=your_pgadmin_password

   ```

3. **Run the Application**:

   - **Docker (Recommended)**:

     ```bash

     docker-compose up --build

     ```

   - **Local Development**:

     ```bash

     python -m venv venv

     source venv/bin/activate

     pip install -r requirements/dev.txt

     python manage.py migrate # run migrations

     python manage.py runserver # run development server

     ```

4. **Access Services**:

   - APP: [http://localhost:8000](http://localhost:8000)

   - pgAdmin: [http://localhost:8001](http://localhost:8001)

## Architecture

**Tech Stack**:

- **Backend**: Django

- **FrontEnd**: HTML5, CSS3, Bootstrap

- **Database**: PostgreSQL

- **DevOps**: Docker, Docker-compose

## Deployment

Show Deployment Details

### Production

```bash

# Run with Docker Compose

docker-compose -f compose.prod.yaml up -d

```

### Environment Variables

```bash

DATABASE_URL=postgresql://user:pass@host:5432/db

REDIS_URL=redis://host:6379/0

SECRET_KEY=your-secret-key

ALLOWED_HOSTS=your-domain.com

```

## License

MIT License. See [LICENSE](LICENSE).



**⭐ Star this repo if you found it useful!**

Built by [Degisew Mengist](https://github.com/degisew)

[⬆ Back to Top](#hubspot)