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.
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.
To get started with Ask Good Questions, follow these steps:
-
Clone the repository to your local machine:
git clone https://github.com/braweria/ask-good-questions.git
-
Navigate to the project directory:
cd ask-good-questions -
Install the project dependencies using pnpm:
pnpm install
-
Start the development server:
pnpm dev
-
Open your web browser and visit http://localhost:5173 to access Ask Good Questions.
Using Ask Good Questions is simple:
-
Visit the website in your browser.
-
You'll see a few text areas where you can input your question.
-
Once you're satisfied with your question, you can use it in your preferred platform for asking by copying into your clipboard.
We welcome contributions from the community to make Ask Good Questions even better. If you'd like to contribute, follow these steps:
-
Fork the repository to your GitHub account.
-
Create a new branch for your feature or bug fix:
git checkout -b feat/feature-name
-
Make your changes and commit them with a clear and descriptive commit message.
-
Push your changes to your fork:
git push origin feat/feature-name
-
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.
This project is licensed under the MIT License - see the LICENSE file for details.
We would like to thank the open-source community for their valuable contributions and the creators of the technologies we use in this project.
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.