______ _           _     _____                              
|  ___| |         | |   /  ___|                             
| |_  | | __ _ ___| |__ \ `--.__      ____ _ _ __ _ __ ___  
|  _| | |/ _` / __| '_ \ `--. \ \ /\ / / _` | '__| '_ ` _ \ 
| |   | | (_| \__ \ | | /\__/ /\ '  ' / (_| | |  | | | | | |
\_|   |_|\__,_|___/_| |_\____/  \_/\_/ \__,_|_|  |_| |_| |_|
  

FlashSwarm

A tool to create on-the-go swarms.

Table of Contents

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

About The Project

FlashSwarm converts solo coding time into impromptu mini-swarms.

Our app let you:

• Let the team know when and where a swarm is happening
• Send real-time notifications with one-click availability for rapid response
• Record each swarm log for everyone to see in team review

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• npm

  npm install npm@latest -g

  If you do not have npm installed, click here

Installation

1. Clone the repo

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

2. Install NPM packages

   npm install

3. Create a Discord bot, and generate a Discord token (instructions here)

4. Enter your Discord Bot Token in .env

   DISCORD_TOKEN= "Enter The Bot Discord Token"
   PORT = 3000

5. Create a Firebase project and register your app (instructions here); relevant config to replace is at utils/DatabaseFunc.js

6. Configure Firebase (instructions here)

Usage

1. Start the app

   npm run start

   This should start both the web app and start hosting the discord bot.

2. Setup the discord bot by pinging it in the channel you want to send notifications to

3. Start a FlashSwarm using the web app

(back to top)

Known bugs

• If a swarm is created before pinging the bot, an error will occur

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. View license.txt for more information.

(back to top)

Contact

Christopher Riesbeck - [email protected]

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

(back to top)

Acknowledgments

• Professor Risebeck's materials

(back to top)