README.md

🚀 Postify - Share & Connect

Welcome to Postify - Share & Connect, an interactive web application where users can create posts, comment, and participate in raffles. Engage with others, customize your profile, and enjoy a seamless social experience. 💬🎉

---

📌 Features

• ✍️ Create & Share: Post your thoughts and engage with others.
• 💬 Comments & Replies: Interact with posts through comments and replies.
• 🎟️ Raffles & Rewards: Participate in exciting raffles.
• 🎨 Customizable Profiles: Personalize your experience.

---

📂 Project Structure

└── 📁src  
    └── 📁main  
        └── 📁java  
            └── 📁com  
                └── 📁brayanalmengor04  
                    └── 📁postifyv1  // 📌 Main backend package  
                        └── 📁config  // 🔒 Security and system configurations  
                            └── SecurityConfig.java  
                        └── 📁controller  // 🌐 Handles HTTP requests  
                            └── AuthController.java  // Authentication  
                            └── CommentController.java  // Comments management  
                            └── ReplyController.java  // Replies management  
                            └── RoleController.java  // Roles and permissions  
                            └── UserController.java  // User operations  
                        └── 📁dto  // 📌 Data transfer objects (DTOs)  
                            └── CommentDTO.java  
                            └── ReplyDTO.java  
                            └── UserDTO.java  
                        └── 📁entity  // 📌 Database entities  
                            └── Comment.java  
                            └── Reply.java  
                            └── Role.java  
                            └── User.java  
                        └── 📁enums  // 🎭 Enum definitions  
                            └── Permission.java  
                        └── Postifyv1Application.java  // 🚀 Main Spring Boot application  
                        └── 📁repository  // 🗄️ Database access interfaces  
                            └── CommentRepository.java  
                            └── ReplyRepository.java  
                            └── RoleRepository.java  
                            └── UserRepository.java  
                        └── 📁security  // 🔐 Security implementations  
                        └── 📁seeder  // 🌱 Initial database data  
                            └── DatabaseSeeder.java  
                        └── 📁service  // ⚙️ Business logic  
                            └── CommentService.java  
                            └── ICommentService.java  
                            └── ImageService.java  
                            └── IReplyService.java  
                            └── IRoleService.java  
                            └── IUserService.java  
                            └── ReplyService.java  
                            └── RoleService.java  
                            └── UserService.java  
                        └── 📁util  // 🔧 Utility functions  
        └── 📁resources  // 📌 Configuration and static resources  
            └── application.properties  // System settings  
            └── logback-spring.xml  // Logging configuration  
            └── 📁static  // Static assets (images, CSS, JS)  
            └── 📁templates  // View templates  
    └── 📁test  // ✅ Unit and integration tests  
        └── 📁java  
            └── 📁com  
                └── 📁brayanalmengor04  
                    └── 📁postifyv1  
                        └── Postifyv1ApplicationTests.java  

---

⚙️ Tech Stack

Category	Technologies
Frontend	React, TailwindCSS
Backend	Spring Boot, REST API
Database	MySQL 8.0.3

---

🚀 Getting Started

1️⃣ Clone the repositories

git clone https://github.com/brayanalmengor04/postify-backend.git
cd postify

For the frontend, clone the repository:

git clone https://github.com/brayanalmengor04/postify-frontend.git

2️⃣ Backend Setup

cd backend
mvn spring-boot:run

3️⃣ Frontend Setup

cd frontend
npm install
npm run dev

---

🖼️ Screenshots

🔐 Login Page

Users can log in using their credentials to access the platform.

📊 Dashboard

Overview of user activities, including posts, comments, and interactions.

💬 Comments Section

Users can comment on posts and engage in discussions.

🆕 New User Registration

New users can sign up and create an account to start posting.

---

📜 API Endpoints

🔐 Authentication

Method	Endpoint	Description
POST	/auth/signin	User login
POST	/auth/signup	User signup

💬 Comments

Method	Endpoint	Description
GET	/comment	Fetch all comments
POST	/comment-add	Create a comment
PUT	/comment/{id}	Update a comment
DELETE	/comment/{id}	Delete a comment

💬 Replies

Method	Endpoint	Description
GET	/reply/all	Fetch all replies
POST	/reply/user	Create a reply
GET	/reply/user/{userId}	Fetch reply by userID

🛡️ Roles

Method	Endpoint	Description
GET	/role	Get all roles
POST	/role-add	Add a new role
GET	/role/{id}	Get role by ID
PUT	/role/{id}	Update a role
DELETE	/role/{id}	Delete a role

---

💡 Contributing

We welcome contributions to make Postify more efficient, clean, and maintainable! 🚀

🛠️ How You Can Help

We aim for a clean code approach, prioritizing readability, simplicity, and performance. Contributions can include:

• Refactoring code to enhance clarity and maintainability.
• Optimizing database queries for better performance.
• Improving API efficiency to reduce response times.
• Enhancing security by following best practices.
• Writing comprehensive tests to ensure stability.

📝 Contribution Guidelines

1. Fork the repository 🍴
2. Create a feature branch (git checkout -b improve-backend) 🌱
3. Follow best practices (SOLID principles, DRY, KISS) 📜
4. Document your changes clearly in the code 💡
5. Commit changes (git commit -m 'Optimized backend query handling') 💾
6. Push to branch (git push origin improve-backend) 🚀
7. Submit a Pull Request with a clear explanation 📩

We encourage meaningful discussions and improvements. Let’s build a scalable and efficient platform together! 🔥

📜 License

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

---

🚀 Join us and start sharing today! Let’s build something amazing together! 🔥