Skip to content

satyamchaurasia2011/Vichaar

Repository files navigation

Vichaar

Vichaar is a project that is like a online discussion platform. This README provides an overview of the project, how to use it, and how to contribute.

Table of Contents

Features

  • Create and manage posts
  • Post and edit comments
  • Like and Dislike posts
  • User authentication and profiles
  • Create Community and send request to users to join it
  • User roles (admin, moderator, user)
  • Search functionality
  • Notifications
  • and more...

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

  • Node.js: Make sure you have Node.js installed. You can download it here.

Installation

  1. Clone the repository:

    git clone https://github.com/satyamchaurasia2011/Vichaar.git
    
  2. Install dependencies:

    cd vichaar
    npm install 
    
  3. Set up the environment variables:

    • Create a .env file based on the required configuration values.
  4. Start the application:

    npm start
    

Usage

  • Visit the application in your web browser (default: http://localhost:3000).
  • Sign up or log in to create vichaar, post comments, and interact with the community.
  • Explore the various features and enjoy discussions!

Contributing

We welcome contributions from the community. If you'd like to contribute to this project, please follow these guidelines:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix: git checkout -b feature/your-feature-name.
  3. Commit your changes and push to your branch: git push origin feature/your-feature-name.
  4. Submit a pull request to the main repository.