Sample Standby App #19
Conversation
| <img src="https://img.shields.io/badge/React%20Hook%20Form-%23EC5990.svg?style=for-the-badge&logo=reacthookform&logoColor=white"> | ||
| <img src="https://img.shields.io/badge/✋ react use gesture-%23CC342D.svg?style=for-the-badge&logo=&logoColor=white"> | ||
| <img src="https://img.shields.io/badge/webOS-a50034.svg?style=for-the-badge&logo=lg&logoColor=white"> | ||
| <div/> |
There was a problem hiding this comment.
Incorrect tags can affect content style.
correction guide
<div/> -> <div>
| <img src="https://github.com/user-attachments/assets/8fd56178-2bbd-44e9-9dd3-d40a1148b5bb" | ||
| style="width: 50%;"> | ||
| style="width: 49%;"> | ||
| </p> | ||
|
|
||
| <br/><br> |
There was a problem hiding this comment.
need to remove <br> tag
|
|
||
| > Database ERD | ||
| It is a diagram of the overall structure of our system. | ||
| <p align = "center"> |
There was a problem hiding this comment.
need to change this block to {{<figure >}} format.
example)
{{< figure src="url_of_image" caption="caption of image" alt="alternative name of imange" >}}
| </p> | ||
| <p align = "center"> Api documents | ||
| </p> | ||
|
|
||
|
|
||
| ### ✔️Frond-end | ||
| <div> |
There was a problem hiding this comment.
need to remove <div> </div> tag
| ### Client Device | ||
| We need a Raspberry Pi 4 with webOS OSE. | ||
|
|
||
| <dl> |
There was a problem hiding this comment.
need to change this html block as belows:
**Raspberry Pi 4 Model B 8GB**
**MicroSD Card with webOS OSE Image**
- You can get the pre-built image in [this GitHub address](https://github.com/webosose/build-webos/releases/tag/v2.24.0).
- You need to flash this image on a micro sd card.
**Monitor**
- The model we used is a 7-inch Raspberry Pi 1024x600 HDMI touchscreen LCD.
| _(Instructions to be added)_ | ||
| * ensure that you already has some ipk file from repository build command. | ||
|
|
||
| > ares-setup-devices |
There was a problem hiding this comment.
need to change this style as belows:
ares-setup-devices
| <dd>The model we used is a 7-inch Raspberry Pi 1024x600 HDMI touchscreen LCD.</dd> | ||
|
|
||
| ### Host PC | ||
| This is the host pc specification we used. |
There was a problem hiding this comment.
It would be nice to divide the hardware specification and the software specification and specify the software that needs to be installed in the software specification.
| ## How to run | ||
|
|
||
| First of all, I will explain the process from the back-end perspective. | ||
|
|
There was a problem hiding this comment.
It would be nice if you could write the process of running the server in Step by Step.
Example)
- Colne the repository
- Server Setup
...
|
|
||
| The project uses **Yarn 4.5.0** as its package manager, managed as a `.cjs` file in `.yarn/releases`. It requires Node.js version **18 or higher**, and has been tested with version **22.5.1**. | ||
|
|
||
| ### Environment Variables | ||
| <dt>Environment Variables</dt> |
There was a problem hiding this comment.
if you want to use bold style, you can use **strong** format.
|
|
||
| The project uses **Yarn 4.5.0** as its package manager, managed as a `.cjs` file in `.yarn/releases`. It requires Node.js version **18 or higher**, and has been tested with version **22.5.1**. | ||
|
|
||
| ### Environment Variables | ||
| <dt>Environment Variables</dt> | ||
|
|
||
| Before running the project, you need to create an `.env` file in the project root. An example `.env` file is provided as `example.env`. Below are the descriptions of the environment variables: |
There was a problem hiding this comment.
need to example as belows:
PORT = 1234
DATABASE_URL = https://vvv..sss..ddd
...
This is a draft open-source document. We will revise it later and request it again.