Skip to content

Your hub for collaborative questioning, form creation, and shared insights.

License

Notifications You must be signed in to change notification settings

akash-singh8/qanst

Repository files navigation

Qanst is a collaborative Q&A platform that empowers curiosity, connects minds, and facilitates meaningful conversations. Create insightful forms, spark engaging discussions, and explore a world of knowledge together.

Table of Contents

Features

  • Form Creation: Easily create and customize forms to gather insights and questions.
  • Collaborative Inquiry: Engage in collaborative discussions with users to explore diverse perspectives.
  • Shared Wisdom: Build a repository of shared knowledge through questions and answers.

Screenshots

Qanst-Home

image

image

image

Getting Started

To get started with Qanst, follow these steps:

  1. Installation: Clone the repository and install dependencies.

    git clone https://github.com/akash-singh8/qanst.git
    cd qanst
    npm install
  2. Configuration: Set up the environment variables

    a. Duplicate the ".env.example" file and rename it to ".env".
    b. Open the ".env" file and configure the environment variables as needed.
    
  3. Database Migration: Run database migrations to set up your database schema.

    npx prisma migrate dev
  4. Run the App: Start the development server.

    npm run dev
  5. Explore: Open your browser and navigate to http://localhost:3000 to start exploring Qanst.


Setup using Docker

Make sure you have the Docker installed on your machine!

  1. Installation: Clone the repository

    git clone https://github.com/akash-singh8/qanst.git
    cd qanst
  2. Configuration: Set up the environment variables

    a. Duplicate the ".env.example" file and rename it to ".env".
    b. Open the ".env" file and configure the environment variables as needed.
    
  3. Start Docker Compose:

    docker-compose up
  4. Explore: Open your browser and navigate to http://localhost:3000 to start exploring Qanst.


Contributing

We welcome contributions to this project! Here are some ways you can get involved:

  • Report bugs: If you encounter any bugs or issues with this package, please let us know by opening a new issue on our GitHub repository.

  • Suggest new features: If you have an idea for a new feature or improvement, we'd love to hear it! You can suggest a new feature by opening a new issue on our GitHub repository.

  • Submit pull requests: If you'd like to contribute code to this project, you can submit a pull request with your changes.

To submit a pull request, fork this repository, make your changes, and submit a pull request against the your-username-feature branch.

License

This project is licensed under the MIT License
MIT License