Odoo Hackathon 2025 Round1

StackIt - A Modern Q&A Platform

StackIt is a full-featured Q&A platform inspired by Stack Overflow, built with modern web technologies to provide a seamless experience for technical discussions, knowledge sharing, and community engagement.

🚀 Features

• User Authentication: Secure sign up, login, and profile management
• Rich Text Editor: Built with Lexical for a great content creation experience
• Questions & Answers: Post questions and provide detailed answers
• Voting System: Upvote/downvote questions and answers
• Comments: Add context and request clarifications
• Tags & Categories: Organize content for better discoverability
• Real-time Notifications: Stay updated on activities
• Responsive Design: Works on all devices

🛠️ Tech Stack

Frontend

• React 19
• Vite (Build Tool)
• React Router DOM (Routing)
• Lexical (Rich Text Editor)
• Bootstrap 5 (Styling)
• Axios (HTTP Client)
• React Icons
• Lottie Animations

Backend

• Node.js with Express
• MongoDB (Database)
• Mongoose (ODM)
• JWT (Authentication)
• Bcrypt (Password Hashing)
• Nodemailer (Email Notifications)
• Multer (File Uploads)

🚀 Getting Started

Prerequisites

• Node.js (v16 or higher)
• npm or yarn
• MongoDB (local or Atlas)

Installation

1. Clone the repository

   git clone https://github.com/yourusername/StackIt.git
   cd StackIt

2. Set up the backend

   cd backend
   npm install
   cp .env.example .env
   # Update .env with your configuration

3. Set up the frontend

   cd ../frontend
   npm install

4. Start the development servers

   • In the backend directory: npm run dev
   • In the frontend directory: npm run dev

5. Open http://localhost:5173 in your browser.

📂 Project Structure

StackIt/
├── backend/               # Backend server
│   ├── controllers/       # Route controllers
│   ├── db/                # Database connection
│   ├── middleware/        # Custom middleware
│   ├── models/            # Database models
│   ├── routes/            # API routes
│   └── utils/             # Utility functions
├── frontend/              # Frontend React app
│   ├── public/            # Static files
│   └── src/               # Source files
│       ├── components/    # Reusable UI components
│       ├── contexts/      # React contexts
│       └── ...
└── README.md              # This file

🤝 Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository
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

📝 License

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

🙏 Acknowledgments

• Inspired by Stack Overflow
• Built with amazing open source technologies
• Created for Odoo Hackathon 2025