-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/SEP4Y-S24/frontend
- Loading branch information
Showing
1 changed file
with
67 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# Smart Clock React Web Application | ||
|
||
Welcome to the Smart Clock React Web Application! This project is designed to provide you with a comprehensive and interactive clock interface that includes timekeeping, messaging, environmental monitoring, and task management functionalities. | ||
|
||
## Table of Contents | ||
|
||
- [Features](#features) | ||
- [Installation](#installation) | ||
- [Usage](#usage) | ||
|
||
|
||
## Features | ||
|
||
### Timekeeping and Alarms | ||
- **Current Time Display:** Always know the accurate time. | ||
- **Alarm Management:** Create, delete, enable, and disable alarms to stay on schedule. | ||
|
||
### Messaging | ||
- **Send Messages:** Communicate with other users. | ||
- **View Received Messages:** Stay updated with all your messages. | ||
- **View All Messages:** Ensure no message is missed. | ||
|
||
### Environmental Monitoring | ||
- **Current Temperature and Humidity:** Get real-time insights into your indoor environment. | ||
- **Historical Humidity Data:** View the average humidity for the past 30 days. | ||
- **CO2 Levels and Air Quality:** Monitor air quality and CO2 levels to ensure a healthy environment. | ||
- **Graphical Data Representations:** View temperature, humidity, and air quality data over various periods (current day, day before, last week, last month). | ||
|
||
### Task and Event Management | ||
- **Task Management:** Create, update, delete, and view tasks with details such as name, description, deadline, and status (To do, In progress, Finished). | ||
- **Event Management:** Create, update, delete, and view events with details such as name, description, start date-time, and end date-time. | ||
- **Categorization:** Categorize tasks and events for better organization. | ||
- **Filtering:** Filter tasks and events by day, week, month, and category. | ||
|
||
## Installation | ||
|
||
To get started with the Smart Clock React Web Application, follow these steps: | ||
|
||
1. **Clone the repository:** | ||
```bash | ||
git clone https://github.com/yourusername/smart-clock-react.git | ||
cd smart-clock-react | ||
``` | ||
|
||
2. **Install dependencies:** | ||
```bash | ||
npm install | ||
``` | ||
|
||
3. **Start the development server:** | ||
```bash | ||
npm start | ||
``` | ||
|
||
4. Open your browser and navigate to `http://localhost:3000` to view the application. | ||
|
||
## Usage | ||
|
||
Once the application is running, you can: | ||
|
||
- View the current time and manage alarms. | ||
- Send and receive messages. | ||
- Monitor environmental data such as temperature, humidity, and air quality. | ||
- Manage tasks and events, including creating, updating, deleting, and categorizing them. | ||
|
||
|
||
|