Giter Club home page Giter Club logo

ask-good-questions's Introduction

Ask Good Questions

Introduction

Ask Good Questions is a web application designed to help users formulate their questions effectively, leading to better answers and happier helpers. We've all been in situations where we needed assistance, whether in an online forum, a Q&A platform, or just seeking advice from a colleague or friend. The quality of the answers we receive often depends on the clarity and precision of our questions. This tool is here to assist you in crafting questions that will maximize the value of the responses you receive.

Technologies Used

Ask Good Questions is built using the following technologies:

  • pnpm: Our package manager of choice for managing project dependencies.
  • Alpine.js: A minimal framework for composing JavaScript behavior in your HTML, providing a smooth and interactive user experience.
  • Tailwind CSS: A utility-first CSS framework that allows for rapid UI development with a highly customizable design.
  • marked.js: A markdown parser and compiler for rendering markdown content within the application.

Getting Started

To get started with Ask Good Questions, follow these steps:

Prerequisites

Installation

  1. Clone the repository to your local machine:

    git clone https://github.com/braweria/ask-good-questions.git
  2. Navigate to the project directory:

    cd ask-good-questions
  3. Install the project dependencies using pnpm:

    pnpm install
  4. Start the development server:

    pnpm dev
  5. Open your web browser and visit http://localhost:5173 to access Ask Good Questions.

Usage

Using Ask Good Questions is simple:

  1. Visit the website in your browser.

  2. You'll see a few text areas where you can input your question.

  3. Once you're satisfied with your question, you can use it in your preferred platform for asking by copying into your clipboard.

Contributing

We welcome contributions from the community to make Ask Good Questions even better. If you'd like to contribute, follow these steps:

  1. Fork the repository to your GitHub account.

  2. Create a new branch for your feature or bug fix:

    git checkout -b feat/feature-name
  3. Make your changes and commit them with a clear and descriptive commit message.

  4. Push your changes to your fork:

    git push origin feat/feature-name
  5. Open a Pull Request (PR) on the main repository. Please make sure your PR title is descriptive and concise. Mention the issue you are addressing in the PR description, if applicable.

We appreciate your contributions and will review your PR as soon as possible.

License

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

Acknowledgments

We would like to thank the open-source community for their valuable contributions and the creators of the technologies we use in this project.

Contact

If you have any questions, suggestions, or feedback, feel free to open an issue on the repository.

Thank you for using Ask Good Questions! We hope it helps you ask better questions and receive more helpful answers.

ask-good-questions's People

Contributors

caseojkl avatar ekwoka avatar raederdev avatar wiktoriavh avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

ask-good-questions's Issues

fix: route to /accessibility-statement not working

As a user when clicking on /accessibility-statement in the footer,
it directs me to the homepage,
instead of to the /accessibility-statement page

Config needs update:

export default defineConfig({
  build: {
    outDir: 'build',
    rollupOptions: {
      input: {
        main: resolve(__dirname, 'index.html'),
        other: resolve(__dirname, 'other/index.html'),
      },
    },
  },
});

chore: add husky pre-commit for formatting

We could have pre-commit formatting with a certain configuration to avoid different formatting across developers.


Tasks:

  • Default eslint config
  • Default prettier config
  • husky pre-commit for formatting and linting
  • lint-stage for staged files

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.