📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 HubSpot

HubSpot is 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 text messaging, user authentication, roles, and permissions.

🛠 Built With

• Django

Tech Stack

• Python
• Django
• Django-rest-framework

Server

• Django

Database

• PostgreSQL

Key Features

• Users can create a room and discuss with others
• Users can connect with friends
• Hosts can create, delete, and update their rooms and messages
• Users can check recent activities in the room

(back to top)

🚀 Live Demo

Not Available yet!

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

To run this project you need:

• to have Python installed on your machine
• to have PostgreSQL installed on your machine

Setup

To get a local copy up and running follow these simple example steps.

1. Navigate to a folder where you want the cloned file to appear

2. Clone this repo in your terminal or git bash using the command

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

3. Run the following command to install all the necessary dependencies

 cd HubSpot
 pip install pipenv
 pipenv install    # This will create a virtual env't and install dependencies in the virtual env't.

4. Navigate to the folder called HubSpot/ and open this project using your editor

Usage

To run the project, first activate your virtual environment:

  pipenv shell

Once you have activated, execute the following command to run the server:

cd HubSpot

For Mac/Linux run:
 python3 manage.py runserver

For Windows run:
 python manage.py runserver

• This above command will start the Django server in your browser

It runs the app in the development mode.
Open http://localhost:8000 to view it in your browser.

Deployment

You can deploy this project using:

• pythonanywhere
• Heroku
• Renderer

(back to top)

👥 Authors

👤 Degisew

• GitHub: degisew
• LinkedIn: Degisew
• Twitter: @Dj_etiya

(back to top)

🔭 Future Features

• Deploy and expose to the public

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project give a ⭐️ to repo.

(back to top)

🙏 Acknowledgments

I want to thank all my supporters.

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)