Readit - a reddit clone

Readit is a full-stack Reddit clone; it's a comprehensive web application inspired by Reddit, built using Flask and its diverse libraries for the backend, combined with PostgreSQL for robust database management. The frontend is developed using React.js and its rich set of libraries, offering a seamless and dynamic user experience.

Contents

• Introduction
• Technologies
  • Backend
  • Frontend
  • Database
• Features
  • User
  • Subthread
  • Posts Browsing
  • Post
  • Comments
  • Messages
• Project Setup Instructions
  • Database Setup
  • Backend Setup
  • Running the Application
  • Access the Application
• Hosting

Introduction

Readit is a personal portfolio project inspired by Reddit that replicates some of Reddit's core features. While not intended as a fully functional product, Readit serves as a demonstration of various web development skills and technologies.

The backend of Readit is built with Flask, PostgreSQL, and several associated libraries for robust database management. On the frontend, React.js is used to create a dynamic and responsive user interface. The project also leverages additional technologies like tanstack/react-query, Axios, React Router Dom, Framer Motion, and PropTypes to enhance the overall user experience.

Please note that Readit is a work in progress, and features may be added or removed as the project evolves.

Technologies

Backend

For the backend of this project, a stack of versatile technologies has been employed. Python serves as the foundation, providing the flexibility and robustness necessary for web application development. The Flask framework, known for its simplicity and efficiency, has been instrumental in building the core structure. Additional libraries such as Flask Login, Flask Marshmallow, Flask SQLAlchemy, and Bcrypt have been integrated to enhance functionality, handle data, and ensure security. A full list is in requirements.txt.

Frontend

On the front end, the project leverages a stack of essential technologies and libraries. React.js, the cornerstone of the frontend, provides the foundation for building dynamic and responsive user interfaces. To handle data communication with the backend and manage application state effectively, the project incorporates "tanstack/react-query. Axios is also integrated for efficient API requests, while React Router Dom ensures seamless navigation within the application. For added interactivity and animations, Framer Motion is utilized, enhancing the overall user experience. The project also employs PropTypes for enhanced type checking and validation.

Database

The project's backend relies on PostgreSQL, a robust and open-source relational database system, to effectively handle data storage and management. Details about the schema, views, and relationships can be found in the backend folder as an SQL file; the schema is shown below.

Features

In this project, I've implemented a set of features, which are shown below. It's important to note that features may be added or removed depending on development progress and evolving project goals. Additionally, there are pending features currently in development, as this project remains a work in progress.

User

• Login & Logout
• Register
• Edit Profile
• Delete Account

Subthread

• Subthread Creation
• Subthread Edit (by Mod, Admin, and Creator)
• Subthread Moderation (by Mod and Admin)
• Join Subthread
• Leave Subthread
• Search Subthreads
• Subthread Logo and Descriptions

Posts Browsing

• Sort by Top, Hot, and New
• Sort by duration.
• Responsive Layout

Post

• Post Creation
• Post Edit
• Post Delete (by Mod, Admin, and Creator)
• Post Save & Unsave
• Ability to add an image to a post
• Ability to add video and gifs
• Use Markdown instead of plain text.

Comments

• Create Comments
• Edit Comments & Edit Indicator
• Delete Comments
• Comment Tree with on-demand expansion
• Use Markdown instead of plain text.

Messages

• Send & Receive
• Message Seen Indicator

Project Setup Instructions

Database Setup

• Ensure that PostgreSQL is installed on your system.
• Create a PostgreSQL database with a name of your choice.
• Make sure you have the necessary credentials (username and password) for this database.
• Details about the schema, views, and realtions can be found in the backend folder in a SQL file.

Backend Setup

1. Navigate to the project's backend folder.

2. Create a .env file in the backend folder and include the following environment variables:

DATABASE_URI=your_postgresql_database_uri
SECRET_KEY=your_flask_secret_key
CLOUDINARY_CLOUD_NAME=your_cloudinary_cloud_name
CLOUDINARY_API_KEY=your_cloudinary_api_key
CLOUDINARY_API_SECRET=your_cloudinary_api_secret

Replace the placeholder values with your specific credentials.

Running the Application

1. With the database set up and the environment variables configured, execute the run.py file in the backend folder to start the Flask application.
2. Open a terminal, navigate to the backend folder, and run: python run.py

This will start the Flask server.

Access the Application

• Once the Flask server is running, you can access the application by opening a web browser and navigating to the URL where it's hosted, or you can use localhost if you're running it locally.

By following these steps, you should have the project up and running with the necessary database schema and environment variables configured. Make sure to replace the placeholder values with your actual credentials and API keys.

Random change 16419