YourTurn

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

A swarm rotation timer and more!

• rotation timer alarm with two-minute warning
• can customize timer duration and pause/resume at will
• view queue to prepare in advance
• one-click rotation order generation to ensure fair "who's on first"

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

These are instructions on setting up our project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/394-s24/YourTurn.git

2. Install NPM packages

   npm install

3. Add the firebase configuration to App.jsx

   const firebaseConfig = {
   apiKey: "firebase API key here",
   authDomain: "firebase domain here",
   projectId: "firebase project id",
   storageBucket: "firebase storage bucket",
   messagingSenderId: "firebase messaging sender id",
   appId: "firebase app id",
   measurementId: "firebase measurement id"
   };

(back to top)

Firebase Configuration

1. Login to Firebase.

   firebase login

Follow the instructions in the browser and use your Google account credentials to sign in. If you don't have a Google account, go to Google Account, fill in the required details such as First Name, Last Name, Username, and Password, and follow the prompts to verify your account.

2. Initialize Firebase.

   firebase init

• What Firebase features do you want? Pick
  • Database for the Realtime Database
  • Hosting if you want to deploy your web app onto the Firebase server
• What Firebase project to connect to? Pick the one you created.
• What is your public directory? Enter dist. Do not accept the default value "public".
• Is this a single page webapp? Say Yes.
• Overwrite dist/index.html? Say No.
• Add Github Integration. Say No.

No starting data has to be imported into the database.

(back to top)

Known Bugs

Currently, there are no known bugs.

(back to top)

Usage

Start a swarm by entering your name and clicking 'Create New Swarm'. Alternatively, you can also enter a room code and click 'Join Swarm' to join an existing swarm. Once you're in, set the timer to your required duration and click 'Start'. You can then pause, resume and reset the timer at will. You can also enter the time at which you would like a warning for how many minutes are left in the rotation. View the queue right below the timer to see who's next.

(back to top)

Roadmap

• Swarm Creation and Room Code Generation
  • Join or Leave Existing Swarm
• Set Timer Duration
• Start/Pause the Timer
• Set Time for Warning Notification
  • Visual + Audio Notification
• Manually End a Swarm

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Team Orange - Anoushka, Joel, Carol, Hong, Rachel, Eric

Project Link: https://github.com/394-s24/YourTurn

(back to top)