Merge branch 'main' of https://github.com/Nathaniel81/Rabbit

README.md

@@ -1 +1,33 @@
-# Rabbit
+# Rabbit: A Social Media Platform Inspired by Reddit
+
+## Introduction
+
+Rabbit is a personal project that I developed to deepen my understanding of full-stack development. It's a social media platform, inspired by Reddit, where users can join rooms, create posts, and engage in discussions.
+
+## Technology Stack
+
+- **Frontend**: React with TypeScript, Tailwind CSS, ShadcnUI
+- **Backend**: Django
+- **Database**: PostgreSQL
+
+## Key Features
+
+- **Post and Comment Voting**: Rabbit incorporates a voting system for posts and comments. The content with the highest vote difference is cached and displayed prominently.
+- **GitHub OAuth Authentication**: Rabbit integrates GitHub OAuth for user authentication, ensuring a secure login process.
+- **Post Creation with Editor.js**: Rabbit utilizes Editor.js for post creation, providing a rich text editing experience.
+
+## Learning Experience
+
+The journey of developing Rabbit was filled with learning opportunities. One of the significant challenges was integrating Editor.js on both the frontend and backend, which enhanced my understanding of rich text editing in web applications. 
+
+Building a platform similar to Reddit also provided insights into features like post and comment voting and caching popular content. Implementing GitHub OAuth authentication was another highlight, reinforcing the importance of secure and user-friendly authentication methods.
+
+Stay tuned for more updates as I continue to refine and expand this project!
+
+## Get in Touch
+
+I welcome any questions or suggestions. Your feedback is greatly appreciated!
+
+## **Live Demo**
+
+