Reddit Clone

Overview

A Reddit-like web application built with Django, offering users the ability to create posts, comments, and interact within different subreddits.

📝Functional Requirements

• Post System

• Comment System

• Voting System

• User Profile System

• Community Creation and Management

• Community Member Hierarchy and Permissions

• Community Event Creation and Management

📊 Gantt Chart

🔗 ERD

🎨 UI/UX

🛠 Tech Stack

📦 Prerequisites

🚀 Installation

1. Clone the repository

git clone https://github.com/Kuugang/redditclone-django.git
cd redditclone-django

2. Create virtual environment

python -m venv venv
source venv/bin/activate  # On Windows, use `venv\Scripts\activate`

3. Install dependencies

pip install -r requirements.txt

4. Create .env file

touch .env

5. Configure environment variables in .env

DATABASE_HOST = 'YOUR DATABASE HOST'
DATABASE_NAME = 'YOUR DATABASE NAME'
DATABASE_PORT = 'YOUR DATABASE PORT'
DATABASE_USER = 'YOUR DATABASE USER'
DATABASE_PASSWORD = 'YOUR DATABASE PASSWORD'
GOOGLE_OAUTH_CLIENT_ID= 'YOUR GOOGLE WEB APP OAUTH CLIENT ID'
EMAIL_HOST_USER = 'YOUR EMAIL HOST USER'
EMAIL_HOST_PASSWORD = 'YOUR EMAIL HOST PASSWORD'

6. Run migrations and seeding

python manage.py migrate
python manage.py populate_topics

7. Collect static files

python manage.py collectstatic

8. Start the development server

python manage.py runserver

🔒 Security Note

• Never commit .env file to version control
• Use a .gitignore file to exclude sensitive credentials
• Rotate credentials periodically

🤝 Contributing

1. Fork the repository

2. Create your feature branch (git checkout -b feature/AmazingFeature)

3. Commit your changes (git commit -m 'Add some AmazingFeature')

4. Push to the branch (git push origin feature/AmazingFeature)

5. Open a Pull Request

🎉 Acknowledgements

• Django

• Tailwind CSS

• Flowbite