Skip to content

README.md

Latest commit

 

History

History
113 lines (72 loc) · 2.78 KB

README.md

File metadata and controls

113 lines (72 loc) · 2.78 KB

DebugDiary 📝

DebugDiary is a platform for developers to document, track, and share their coding problems, solutions, and projects — all in a collaborative, community-driven environment. It’s designed for learning in public, building together, and contributing to open-source projects.

🌟 Features

  • Problem Documentation: Save your bugs, errors, or coding challenges with step-by-step solutions.
  • Project Contributions: Developers can contribute new features or improve existing ones.
  • Live Feature Experience: See your contribution used in real-world scenarios.
  • Community Collaboration: Connect with like-minded developers, share knowledge, and learn together.
  • Public Learning: Build your coding portfolio by documenting problems and solutions publicly.
  • Future Features Coming Soon: Analytics, personalized dashboards, and mentorship programs.

🚀 Getting Started

Prerequisites

Make sure you have the following installed:

Installation

  1. Clone the repository
git clone https://github.com/frazhaidry/DebugDairy.git
  1. Install dependencies
npm install
# or
yarn install
  1. Set up environment variables

Create a .env file in the root directory:

PORT=5000
MONGO_URI=your_mongodb_connection_string
JWT_SECRET=your_secret_key
  1. Start the application
npm run dev
# or
yarn dev

The app should now be running on http://localhost:5000.

🛠️ Technologies Used

  • Frontend: React, Tailwind CSS, Next.js (if applicable)
  • Backend: Node.js, Express.js
  • Database: MongoDB
  • Authentication: JWT
  • File Uploads: Multer

🤝 Contributing

We welcome developers to contribute to DebugDiary! You can:

  • Report bugs
  • Suggest new features
  • Build new features
  • Improve existing features

Steps to Contribute:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/your-feature)
  3. Make your changes and commit (git commit -m "Add feature")
  4. Push to the branch (git push origin feature/your-feature)
  5. Open a Pull Request

📄 License

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

💡 Join Us

Come and develop new features, improve existing features, and learn in public with other developers! 🚀

DebugDiary — Where developers learn, build, and grow together!