Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chuma-beep authored Oct 13, 2024
1 parent 6a0d4af commit 514de89
Showing 1 changed file with 60 additions and 0 deletions.
60 changes: 60 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,61 @@
# The Paragraph

**Overview**
The Paragraph is a multi-functional platform designed for authors and readers who crave more text-based content in a world dominated by images, short videos, and social media trends. This platform aims to create a space for traditional bookworms and writers to create, share, and discover content.

## Features

### 1. **User Registration and Authentication**
- Users can register and create accounts using github or Google.
- Secure login and authentication processes ensure user data privacy.

### 2. **Content Creation**
- A rich text editor is provided, enabling users to create and publish content.
- Posts are authored in **Markdown** format and rendered as HTML when displayed.
- Users can enhance their content with images and videos, offering flexibility in how they present their ideas.


### 3. **Social Features**
- Users can interact through likes and comments, fostering discussion and engagement within the community.

### 4. **Analytics**
- Users can track views, likes and comments on their content.
- This feature helps users understand their audience and the performance of their content.

## Technologies

1. **Code Quality and Formatting**
- **ESLint**.

2. **Frontend Technologies**
- **Nextjs**

3. **Backend Technologies**
- **Supabase**

5. **Markdown Support**
- **Blocknote**


4. **Testing**
- **Cypress**

## Goals
Chatter aims to:
- Create a vibrant platform for text-focused content creators and readers.
- Provide an engaging experience with personalized recommendations, social interactions, and detailed analytics.

---

This README serves as a guide for developers and contributors to understand the structure and goals of the project.
## Contribution


- ** npm install **

Create a new issue.
Please use a clear and descriptive title that summarizes the issue.
You can either contribute and resolve the issue yourself, or you can patiently await someone else to address it. It's important to note that simply opening a new issue is also appreciated and recognized.

If you have any questions or need further assistance, feel free to reach out to me or open an issue.

0 comments on commit 514de89

Please sign in to comment.