FriendlyDebate

A small very simple tool for helping friends debate with a timer, speaker, participant turns.

Purpose

FriendlyDebate is a fun side project designed to help friends engage in enjoyable debates. It provides a basic speak timer and a quick moderator for chiller debates.

Features

• Debate Setup: Easily set up a debate with a topic and participants.
• Timer: A countdown timer for each speaker's turn.
• Participant List: Manage and display the list of participants.
• Time Up Alert: Alerts when a speaker's time is up.
• Speaker Controls: Controls for managing the current speaker and ending turns early.

Usage Instructions

1. Setup Debate: Enter the debate topic and add participants.
2. Start Debate: Begin the debate and the timer will start for the first speaker.
3. Manage Turns: Use the speaker controls to manage turns and end them early if needed.
4. Time Up Alert: An alert will notify when a speaker's time is up.

Setup

To set up the project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/Qredence/FriendlyDebate.git
   cd FriendlyDebate

2. Install dependencies:

   npm install

3. Build the app:

   npm run build

4. Start the development server:

   npm run dev

5. Open the app in your browser: Navigate to http://localhost:5176 to see the app in action.

Build the app

To build the app, run the following command:

npx vite build

Run the app

To run the app, use the following command:

npm run dev

Hosted Online Version

You can access the hosted online version of the app at the following link: https://debate.qredence.ai

Contributing

We welcome contributions to FriendlyDebate! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request. Here are some ways you can contribute:

• Report Bugs: If you find a bug, please report it by opening an issue.
• Suggest Features: If you have an idea for a new feature, please let us know by opening an issue.
• Submit Pull Requests: If you want to contribute code, please fork the repository and submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Acknowledgements

This project was built using Bolt.new and Onlook.