Effortlessly create random pairings and groups for your team, class, or event. Pair Form makes group generation simple and fair.
- Random Group Generation: Automatically generate random pairs or groups based on your participants.
- Authentication: Secure Sign Up and Sign In functionality using Firebase.
- Participant Management: Easily add and manage users for your events.
- Dashboard: A central hub to view and manage your pairings.
- Event Creation: Create custom events, specifying group sizes and other parameters.
- Share Results: Generate unique URLs to share grouping results with others.
- Framework: React with Vite
- Language: TypeScript
- Styling: Tailwind CSS
- Authentication & Backend: Firebase
- State Management: React Hooks & Context
- Forms: Formik & Yup
- Notifications: React Toastify
- Icons: React Icons
Follow these instructions to get a copy of the project up and running on your local machine.
Make sure you have Node.js installed on your system.
-
Clone the repository:
git clone https://github.com/your-username/random-selection.git cd random-selection -
Install dependencies:
npm install
-
Set up Environment Variables: Create a
.env.localfile in the root directory and add your Firebase configuration keys:VITE_FIREBASE_API_KEY=your_api_key VITE_FIREBASE_AUTH_DOMAIN=your_auth_domain VITE_FIREBASE_PROJECT_ID=your_project_id VITE_FIREBASE_STORAGE_BUCKET=your_storage_bucket VITE_FIREBASE_MESSAGING_SENDER_ID=your_sender_id VITE_FIREBASE_APP_ID=your_app_id
Start the development server:
npm run devOpen http://localhost:5173 (or the port shown in your terminal) to view it in the browser.
To build the app for production:
npm run buildTo preview the production build locally:
npm run previewThis project is licensed under the MIT License.