Threadly

Threadly is a backend application designed to mimic the functionality of Reddit. It provides APIs for user authentication, subreddit management, post creation, and comment handling.

Table of Contents

• Features
• Installation
• API Documentation
  • Authentication Routes
  • Subreddit Routes
  • Post Routes
  • Comment Routes
• Technologies Used

---

Getting Started

To get started with Threadly, follow these steps:

1. Ensure you have Node.js and npm installed on your system.
2. Clone the repository and navigate to the project directory.
3. Install the dependencies using npm install.
4. Set up the .env file with the required environment variables.
5. Run the development server using npm run dev.

For more details, refer to the Installation section.

Features

• User registration and login with JWT-based authentication.
• Subreddit creation, update, and deletion.
• Post creation and retrieval by subreddit.
• Comment creation, update, and deletion with ownership validation.

---

Installation

1. Clone the repository:

   git clone https://github.com/f0rsakeN-afk/Threadly.git
   cd Threadly

2. Install dependencies:

   npm install

3. Set up environment variables: Create a .env file in the root directory and configure the required variables (e.g., database connection, JWT secret).

4. Run the development server:

   npm run dev

5. Build for production:

   npm run build

6. Start the production server:

   npm start

---

Voting Routes

Method	Endpoint	Description	Protected
POST	/	Vote on a post (upvote/downvote)	Yes

---

License

Threadly is licensed under the MIT License. See the LICENSE file for details.

Folder Structure

The project structure is organized as follows:

Threadly/
├── dist/               # Compiled JavaScript files
├── generated/          # Auto-generated files (e.g., Prisma client)
├── node_modules/       # Dependencies
├── prisma/             # Prisma schema and migrations
├── src/                # Source code
├── .gitignore          # Git ignore rules
├── LICENSE             # License information
├── README.md           # Project documentation
├── package.json        # Project metadata and scripts
├── tsconfig.json       # TypeScript configuration

This structure ensures a clean separation of concerns and easy navigation.

---

Contributing

We welcome contributions to Threadly! To contribute:

1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Commit your changes with clear and concise messages.
4. Push your branch and create a pull request.

Please ensure your code adheres to the project's coding standards and includes relevant tests.

API Documentation

Authentication Routes

Method	Endpoint	Description	Protected
POST	/register	Register a new user	No
POST	/login	Login and get a JWT token	No
POST	/forgotPassword	Request a password reset	No
POST	/resetPassword	Reset the user's password	No
PATCH	/updatePassword	Update the user's password	Yes

---

Subreddit Routes

Method	Endpoint	Description	Protected
GET	/	Get all subreddits	No
POST	/	Create a new subreddit	Yes
PATCH	/:id	Update a subreddit (ownership)	Yes
DELETE	/:id	Delete a subreddit (ownership)	Yes

---

Post Routes

Method	Endpoint	Description	Protected
GET	/r/:slug	Get posts by subreddit slug	No
POST	/	Create a new post	Yes

---

Comment Routes

Method	Endpoint	Description	Protected
GET	/:postId	Get comments for a specific post	No
POST	/	Create a new comment	Yes
PATCH	/:id	Update a comment (ownership)	Yes
DELETE	/:id	Delete a comment (ownership)	Yes

---

Technologies Used

• Node.js: Backend runtime.
• Express: Web framework.
• Prisma: ORM for database management.
• PostgreSQL: Relational database
• TypeScript: Type safety.
• JWT: Authentication.
• Zod: Schema validation.

---