This is a Next.js project bootstrapped with create-next-app.
This project uses next/font to automatically optimize and load Inter, a custom Google Font.
- 🌐 Demo
- 🤖 Introduction
- 📝 Description
- ⚙️ Tech Stack
- 🔋 Features
- 🛠️ Setup
- 🔍 Usage
- ✅ To-do
- 📜 Credits
- 📚 References
- 📞 Contact
- 📋 License
Here is a working live demo: DevOverflow
DevOverflow - A StackOverflow clone. It includes features such as a recommendation system for posts, global database data-fetching, AI generated answers to questions, badge & reputation system, views & voting mechanism and filter & pagination.
Welcome to my project! Here, I'll provide you with a brief overview of what inspired me to create it, why it solves a problem, and what I've learned throughout its development.
- Motivation: I was motivated to build this project to address a specific issue and to enhance my coding skills.
- Why I Built This Project: My main goal was to create a practical and user-friendly solution to a real-world problem.
- Problem Solved: This project aims to simplify a particular task, making it more efficient and accessible.
- What I Learned: Throughout the development process, I gained valuable insights into various technologies and programming concepts.
- Next.js
- TypeScript
- TinyMCE
- MongoDB
- Shadcn
- Tailwind CSS
- Mongoose ORM
- Clerk
- AuthO
- React-Hook form
- Zod
👉 Authentication: Seamlessly log in or sign up.
👉 Profile Management: Easily update profile details and link social media accounts for enhanced connectivity.
👉 Create: Question and Answers.
👉 Tagging for Context: Enhance post context and retrieval efficiency with intuitive tagging.
👉 Search & Filter: Retrieve past questions and answers swiftly with global search and filtering.
👉 Post Collection: Explore content easily with pagination features.
👉 Responsive: Ensures seamless functionality and aesthetics across all devices and many more, including code architecture and reusability
To get this project up and running in your development environment, follow these step-by-step instructions.
We need to install or make sure that these tools are pre-installed on your machine:
- Clone the Repository
git clone [email protected]:ManmeetSinghJohal/devoverflow.git- Install packages
npm install
- Create a
.envfile
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_test_........
CLERK_SECRET_KEY=sk_test_Or.........
NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=/
NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=/
NEXT_CLERK_WEBHOOK_SECRET=whsec.........
NEXT_PUBLIC_TINY_EDITOR_API_KEY=12kr........
MONGODB_URL=mongodb+srv://........
NEXT_PUBLIC_SERVER_URL=http://localhost:3000
OPENAI_API_KEY=sk-jNSD.........- Run the dev server.
npm run devTo clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
# Clone this repository
$ git clone [email protected]:ManmeetSinghJohal/devoverflow.git
# Go into the repository
$ cd projectname
# Install dependencies
$ npm install
# Run the app
$ npm run devNote If you're using Linux Bash for Windows, see this guide or use
nodefrom the command prompt.
Want to contribute? Great!
To fix a bug or enhance an existing module, follow these steps:
- Fork the repo
- Create a new branch (
git checkout -b improve-feature) - Make the appropriate changes in the files
- Add changes to reflect the changes made
- Commit your changes (
git commit -am 'Improve feature') - Push to the branch (
git push origin improve-feature) - Create a Pull Request
If you find a bug (the website couldn't handle the query and / or gave undesired results), kindly open an issue here by including your search query and the expected result.
If you'd like to request a new function, feel free to do so by opening an issue here. Please include sample queries and their corresponding results.
Will update soon!
None for this project.
