-
Notifications
You must be signed in to change notification settings - Fork 30
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
idle view #21
base: develop
Are you sure you want to change the base?
idle view #21
Conversation
|
||
**Author: Kangin Lee, Seungjin Kim, Tutku Genis** | ||
|
||
## Table of Contents |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since the sidebar contains a Table of Contents, the ToC in the body is redundant.
|
||
<p align="center"> <img src="https://github.com/ttkgns/Idle-View-team7/blob/main/dashboard_heritage_red.png?raw=true" alt="alt text" /> </p> | ||
|
||
<p align="center"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The distorted image looks unnatural, so you need to update it with one that has the right resolution.
|
||
|
||
|
||
### Key Features |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You should refer to resources such as detailed diagrams, infographics, or explanatory images to better understand how each feature functions.
|
||
|
||
### Key Features | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You should add a short explaining what this section covers.
|
||
### Host PC | ||
|
||
Our team developed this project using a Windows environment. However, the project can be set up and executed on other operating systems such as Linux or macOS. The following are the general specifications and software requirements for the host PC: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since the audience is reading (in the second person), explanations starting with a subject such as "our team" are unnecessary. You would better suggest a method to set it according to the environment.
|
||
1. **Clone the repository.** | ||
```sh | ||
git clone <repository_url> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Firstly you need to move "idle-View-team7" folder, right?
--- | ||
|
||
## Software Requirements | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You should add a short explaining what this section covers.
|
||
## Software Requirements | ||
|
||
- **Node.js**: Required for running the backend server and webOS OSE CLI. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If there are version dependencies, you need to show that information.
|
||
1. **Clone the repository.** | ||
```sh | ||
git clone <repository_url> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You need to explain what each folder is for.
1. **Clone the repository.** | ||
```sh | ||
git clone <repository_url> | ||
cd backend |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
change from "backend" to "Idle-View-team7
- **MySQL**: Database management system used in the project. | ||
- **Prisma ORM**: Used for data modeling and database interactions. | ||
|
||
## Version Dependencies in the Project |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This part fits well under the SW Requirements section, and you only need to include SW versions that are closely related to the project execution.
|
||
### Host PC | ||
|
||
This project is developed using a Windows environment. However, the project can be set up and executed on other operating systems such as Linux or macOS. The following are the general specifications and software requirements for the host PC: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You should use positive wording as below:
"We developed this project to work seamlessly in a Windows environment, and you can easily set it up and execute it on other operating systems like Linux and macOS. Below, we outline the general specifications and software requirements for the host PC:"
|
||
- **Customizable Dashboards and Widgets** | ||
Users can personalize their IdleView screen with widgets for weather updates, calendar schedules, media playback, and more. | ||
<p align="center"> <img src="https://github.com/gangin0221/website/blob/main/dashboard_heritage_red.png?raw=true" alt="Customizable Dashboard" width="100%" /> </p> <p align="center"> <small>*Example of a customizable dashboard with various widgets.* </p> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
make sure to close every HTML tag after using it.
|
||
- **Seamless Integration** | ||
A user-friendly interface and backend systems powered by Node.js, MySQL, and REST APIs support personalization and data management. | ||
<p align="center"> <img src="https://github.com/gangin0221/website/blob/main/Integration%20Diagram.png?raw=true" alt="Integration Diagram" width="100%" /> </p> <p align="center"> <small>*Diagram showcasing the seamless integration between the frontend, backend, and database systems.* </p> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
make sure to close every HTML tag after using it.
|
||
- **Real-Time Information Updates** | ||
The system securely retrieves and displays real-time weather updates via HTTPS communication. | ||
<p align="center"> <img src="https://github.com/gangin0221/website/blob/main/weather_widget.png?raw=true" alt="Weather Updates" width="100%" /> </p> <p align="center"> <small>*Real-time weather widget displaying current conditions.* </p> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
make sure to close every HTML tag after using it.
|
||
- **Customizable Dashboards and Widgets** | ||
Users can personalize their IdleView screen with widgets for weather updates, calendar schedules, media playback, and more. | ||
<p align="center"> <img src="https://github.com/gangin0221/website/blob/main/dashboard_heritage_red.png?raw=true" alt="Customizable Dashboard" width="100%" /> </p> <p align="center"> <small>*Example of a customizable dashboard with various widgets.* </p> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please replace it with a different image, as the same one is currently being used.
- **회의록**: (Korean for "meeting records") Contains records of team meetings and discussions. | ||
- **Project Related Files**: Include miscellaneous files or documents relevant to the project. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please remove the descriptions for unnecessary folders for other developers and back up the files before deleting them from the GitHub code.
DATABASE_URL="mysql://root:password@localhost:3306/idleview" | ||
JWT_SECRET=awjdlksejnlsdjgslgang/4ksjfskdvn= # Replace with any random secure string | ||
WEATHER_API_KEY=4c4c552d80ea31da2d4e01e48bc04a61 # Obtain your API key from a weather API provider |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are the three values fixed? If they need to be set individually, please provide an explanation for each one.
Update 2024-12-27-idle-view-app.md
…y folder, provide explanation.
…es for project execution.
change to depoly part and Additional note
Update 2024-12-26-idle-view-app.md
빌드 부분 추가 설명첨부
Update 2024-12-26-idle-view-app.md
No description provided.