Sure, here is the updated and detailed README for your Virtual Breaks application:
Virtual Breaks is an open-source application designed to provide beautiful countdown screens for various breaks in virtual trainings and workshops. It allows users to manage different types of breaks, set durations, change icons, and select time zones. The application also includes features like background music and QR code generation for mobile timer pages.
- Manage different types of breaks (Coffee Break, Lunch Break, Lab Time, etc.)
- Set durations and target times for breaks
- Change icons for each break type
- Select multiple time zones
- Generate QR codes for mobile timer pages
- Background music player during breaks
To run Virtual Breaks locally, follow these steps:
-
Clone the repository:
git clone http://git.fa.edu.vn/qn24_cpl_java_05/team_01/virtualbreak.git cd virtualbreak/project/SPA
-
Install dependencies:
npm install
-
Start the development server:
npm start
The application will be available at http://localhost:3000
.
The Home Page provides a brief overview of the application and a button to get started.
- Click the "Get Started" button to navigate to the Settings page.
The Settings Page allows users to configure different types of breaks, set durations, target times, change icons, and select time zones.
- Select a Break: Click on a break card to select it.
- Edit Name: Click on the break name to edit it.
- Set Duration: For breaks like Coffee Break and Lunch Break, click on the duration to edit it.
- Set Target Time: For Lab Time, use the time picker to set the target time.
- Change Icon: Click on the icon to upload a new one.
- Select Time Zones: Use the multi-select dropdown to choose time zones.
- Click the "Start Break" button to initiate the break.
- If there are any issues (e.g., invalid time zones or durations), a warning message will be displayed.
The Summary Page displays a countdown timer, QR code for mobile access, and the time the break will end in different time zones.
- The countdown timer shows the remaining time until the break ends.
- Background music can be played using the built-in music player.
- Scan the QR code with your smartphone to access a mobile timer page.
- The page shows when the break will end in the selected time zones.
- Click the "Back to Settings" button at the top left to return to the Settings page without losing your configurations.
Contributions are welcome! Please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bugfix:
git checkout -b feature-name
- Commit your changes:
git commit -m "Description of feature or fix"
- Push to your branch:
git push origin feature-name
- Create a pull request.
This project is licensed under the MIT License by Kim Long Tram Kieu Oanh Thi Phan.
t specifics, such as adding actual paths to the screenshots and any additional instructions or sections that might be necessary.