Community & Governance

• 🤝 CONTRIBUTING.md - Guidelines for contributing code, reporting issues, and submitting PRs.
• ⚖️ GOVERNANCE.md - Decision-making processes and project maintainers.
• ❤️ CODE_OF_CONDUCT.md - Standards for community behavior and interaction.

Legal & Safety

• 🛡 SECURITY.md - Security policies and vulnerability reporting.
• ⚠️ DISCLAIMER.md - Project usage disclaimers and liabilities.
• 📜 LICENSE - Licensing details (MIT).

Support

• 🆘 SUPPORT.md - How to get help and support channels.

Sub-Project Documentation

• Backend Documentation
• Frontend Documentation

🚀 Getting Started

Prerequisites

• Node.js: >= 18.x
• npm or yarn or pnpm
• PostgreSQL: Local instance or remote URL
• Git

Installation

1. Clone the repository

   git clone https://github.com/MDF05/dumbmerch.git
   cd dumbmerch
   

2. Install Dependencies It is recommended to install dependencies for root (if any) and individual sub-projects.

   # Backend
   cd backend-dumbmerch
   npm install
   
   # Frontend
   cd ../frontend-dumbmerch
   npm install
   

3. Environment Setup Copy .env.example to .env in both backend-dumbmerch and frontend-dumbmerch directories and populate with necessary credentials (DB URL, API keys, etc.).

4. Running Locally

   Terminal 1 - Backend:

   cd backend-dumbmerch
   npm run dev
   

   Terminal 2 - Frontend:

   cd frontend-dumbmerch
   npm run dev
   

🛠 Tech Stack

Backend (/backend-dumbmerch)

• Runtime: Node.js
• Framework: Express.js
• Language: TypeScript
• ORM: Prisma
• Database: PostgreSQL (Primary)
• Validation: Zod
• Documentation: Swagger UI
• Real-time: Socket.io / WS
• Payment: Midtrans
• Image Storage: Cloudinary

Frontend (/frontend-dumbmerch)

• Framework: React.js
• Build Tool: Vite
• Language: TypeScript
• Styling: Chakra UI, TailwindCSS, Emotion
• State Management: Redux Toolkit
• Forms: React Hook Form, Formik
• Animations: Framer Motion
• Networking: Axios

🤝 Contribution Flow

We welcome contributions! Please see our CONTRIBUTING.md for details on how to get started.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

🛡 Security

For security concerns, please refer to SECURITY.md. Do not report vulnerabilities in public issues.

👥 Maintainers

• Dava - Project Lead - Profile

📄 License

Distributed under the MIT License. See LICENSE for more information.