Thread Clone is a social media thread clone project built using Django and HTMX, allowing users to create and participate in threaded discussions. This README provides an overview of the project and instructions for getting started.
To get started with Thread Clone, follow these instructions:
Before you begin, ensure you have the following prerequisites installed:
- Python (version 3.10.12) or higher
You can install Python from the official Python website.
- Clone the Thread Clone repository to your local machine:
git clone https://github.com/ahnge/thread-clone.git
- Navigate to the project directory:
cd thread-clone- Set up a virtual environment (recommended):
python -m venv venv
- Activate the virtual environment:
On windows:
venv\Scripts\activate
On macOS and Linux:
source venv/bin/activate- Install project dependencies:
pip install -r requirements.txt
- Apply database migrations:
python manage.py migrate
- Create a superuser account for admin access:
python manage.py createsuperuser
- Start the development server:
python manage.py runserver
The Thread Clone should now be running at http://localhost:8000/. You can access the admin interface at http://localhost:8000/admin/ to manage threads and users.
With Thread Clone, users can:
- Create and participate in threaded discussions.
- Reply to existing threads and comments.
- Like and repost threads and comments
- Follow users
- Manage their user profiles.
- To see the project in action, visit the development server URL and start exploring.
We welcome contributions. To contribute:
- Fork the repository on GitHub.
- Create a branch for your feature or bug fix.
- Make your changes and commit them with descriptive messages.
- Push your branch to your fork.
- Open a pull request with details about your changes.
This project is licensed under the GNU General Public License, Version 3 (GPLv3) - see the LICENSE file for details.