Skip to content

Latest commit

 

History

History
99 lines (74 loc) · 2.87 KB

README.md

File metadata and controls

99 lines (74 loc) · 2.87 KB

Mates

Mates is a community-based platform designed for users to ask and answer questions. It encourages interactive discussions and builds a supportive community for solving doubts. Additionally, users can share their thoughts and reviews on various topics, helping to gather public opinions and make informed decisions on important issues.

Features

  • Question and Answer: Post questions and receive answers from the community.
  • Interactive Discussions: Engage in discussions and debates.
  • Public Opinions: Share and gather thoughts on various topics.
  • Voting System: Vote on questions and answers to highlight the most helpful content.
  • Search and Sort: Easily find and organize content for a better user experience.

Tech Stack

  • Backend: Node.js and Express.js
  • Frontend: React.js
  • Database: MongoDB
  • Authentication: JWT Token authentication
  • Rich Text Editor: JODIT Editor

Glimpse of Mates :)

Home Page Question Page
Editor Page User Profile

Installation

  1. Clone the repository

    git clone https://github.com/its-mahi/Mates.git
cd Mates

  2. Backend Setup

    cd backend
npm install
npm start

  3. Frontend Setup

    cd frontend
npm install
npm start

Usage

  1. Running the Application

    • Make sure both backend and frontend are running.
    • Open your browser and navigate to http://localhost:3000.

  2. Register and Login

    • Create an account or login with existing credentials.
    • Use JWT authentication for secure access.

  3. Post Questions and Answers

    • Use the JODIT Editor to format your questions and answers.
    • Vote on questions and answers to influence their visibility.

Learning Outcomes

  • Implementation of JWT token authentication
  • Integration of JODIT Editor for rich text formatting

Contribution

Always welcome contributions to enhance the Mates platform! Please follow these steps:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature-branch)
  3. Commit your changes (git commit -m 'Add some feature')
  4. Push to the branch (git push origin feature-branch)
  5. Open a pull request

If you found this useful, make sure to give it a star 🌟

Thank You!!