DjangoHub - social media

Django / Python

DjangoHub is a social network for discussing web technologies,
with both backend and frontend built using Django.

Index

• DjangoHub - social media
  • Django / Python
• Index
  • Features
  • Technologies and Tools used
• Project Setup
  • Prerequisites
  • Clone the repository
  • Set up the virtual environment
  • Install dependencies
  • Set up the database
  • Create a superuser
  • .env file
  • Run the development server
  • Access the application
  • Contribution
  • Project Status
  • Project Developer

Features

✔️ Register and log in users

✔️ Authentication and restricted routes

✔️ Edit your profile

✔️ CRUD with your own chat room

✔️ CRUD with your own messages

✔️ Chat room with real-time messages and participants

✔️ Filter chat rooms by text input

✔️ Browse topics with room count

✔️ Recent activities with sorted comments

✔️ Flash messages, responsive design, accessibility and SEO.

Technologies and Tools used

Project Setup

These are the instructions to set up and run the Django project in your local environment.

Prerequisites

1. Python: Make sure you have Python 3.6 or higher installed. You can download it from python.org.

2. Pip: Ensure that pip is installed. It usually comes pre-installed with Python.

3. Virtualenv: It is recommended to use a virtual environment to manage the project dependencies. You can install it with the following command:

   pip install virtualenv

Clone the repository

Clone the repository to your local machine using the following command:

  git clone https://github.com/KevinVanDerSchans/social-media-django.git

Set up the virtual environment

Navigate to the project folder and create a virtual environment:

    cd social-media-django
    virtualenv env

Activate the virtual environment:

• On Windows:

    .\env\Scripts\activate

• On macOS and Linux:

    source env/bin/activate

Install dependencies

Install the project dependencies using the requirements.txt file:

    pip install -r requirements.txt

Set up the database

Apply the migrations to set up the database:

    python manage.py migrate

Create a superuser

Create a superuser to access the Django admin:

    python manage.py createsuperuser

.env file

Make sure to create a .env file in the project root for the necessary environment variables.

Run the development server

Run the development server to verify everything is working correctly:

    python manage.py runserver

Access the application

Open your browser and navigate to http://127.0.0.1:8000/ to see the application running.

Contribution

If you want to contribute to this project, follow these steps:

1. Perform a fork to the repository.

2. Create a branch for your feature or bugfix: git checkout -b feature/your-feature-name

3. Make the necessary changes and commits: git commit -m 'Add some feature'

4. Push to branch: git push origin feature/your-feature-name

5. Send a pull request to the original repository.

Project Status

Project Developer

Kevin Schans