README.md

Dev Overflow

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 Dev Overflow

Dev-Overflow is a modern Stack Overflow clone designed for developers to share knowledge and solve problems collaboratively.

🛠 Built With

Tech Stack

• Frontend: Next.js, TypeScript, TailwindCSS, Shadcn
• Backend: MongoDB, Mongoose
• Authentication: Clerk

Key Features

• Create and answer questions
• Interactive likes and commenting
• Reward system for user engagement
• WYSIWYG editor for creating questions and answers
• Advanced search filters

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps:

Prerequisites

Ensure you have the following installed on your system:

• Node.js (>= 14.x)
• npm or yarn
• MongoDB account

Setup

Clone this repository to your desired folder:

git clone git@github.com:adel-gu/dev-overflow.git

Install

Navigate to the project directory and install dependencies:

cd dev-overflow
npm install --legacy-peer-deps

Usage

Create a .env.local file at the root level with the following keys:

NEXT_PUBLIC_CLERK_SIGN_IN_URL=
NEXT_PUBLIC_CLERK_SIGN_UP_URL=
NEXT_PUBLIC_TINY_EDITOR_API_KEY=
MONGODB_STRING_CONNECTION=
SIGNING_SECRET=
NEXT_PUBLIC_SERVER_URL=

To run the project locally:

npm run dev

Run tests

To run tests, execute the following command:

npm run test

(back to top)

👥 Authors

👤 Adel Guitoun

• GitHub: @adel-gu
• Twitter: @GuitounAdel
• LinkedIn: adelguitoun

(back to top)

🔭 Future Features

• Real-time notifications
• Notifications toast component

(back to top)

⭐️ Show your support

If you like this project, please give it a ⭐️!

(back to top)

🙏 Acknowledgements

I want to thank JSM for the Figma design file.

(back to top)

❓ FAQ

• How do I reset my password?

  • Go to the login page and click "Forgot Password" to reset your credentials.

• Can I delete my account?

  • Yes, you can delete your account from the profile settings page.

(back to top)

📝 License

This project is MIT licensed.

(back to top)