Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qredence/friendlydebate
A small very simple tool for helping friends debate with a timer, speaker, participant turns
https://github.com/qredence/friendlydebate
debate-timer friends mobile-first open-source simple-app
Last synced: 28 days ago
JSON representation
A small very simple tool for helping friends debate with a timer, speaker, participant turns
- Host: GitHub
- URL: https://github.com/qredence/friendlydebate
- Owner: Qredence
- License: mit
- Created: 2024-11-28T02:26:56.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-11-28T02:34:55.000Z (about 1 month ago)
- Last Synced: 2024-11-28T03:25:36.542Z (about 1 month ago)
- Topics: debate-timer, friends, mobile-first, open-source, simple-app
- Language: TypeScript
- Homepage:
- Size: 0 Bytes
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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**:
```sh
git clone https://github.com/Qredence/FriendlyDebate.git
cd FriendlyDebate
```
2. **Install dependencies**:
```sh
npm install
```
3. **Build the app**:
```sh
npm run build
```
4. **Start the development server**:
```sh
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:
```sh
npx vite build
```
## Run the app
To run the app, use the following command:
```sh
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](LICENSE) file for more details.
## Acknowledgements
This project was built using Bolt.new and Onlook.