Skip to content
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

Sample Standby App #19

Open
wants to merge 15 commits into
base: develop
Choose a base branch
from
Prev Previous commit
Next Next commit
docs: Change Client Device description
  • Loading branch information
seung365 committed Dec 16, 2024
commit 03566b9e0c0bdba9ce20941b525559b3e1f10071
38 changes: 20 additions & 18 deletions content/en/samples/posts/2024-12-03-stand-by-app-webos.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,14 +176,16 @@ To implement this project, a client device and a host pc are required.

### Client Device

We need a Raspberry Pi 4 with webOS OSE.
**Raspberry Pi 4 Model B 8GB**

<dl>
<dt>Raspberry Pi 4 Model B 8GB<dt>
<dt>MicroSD Card with webOS OSE Image</dt>
<ul><li>You can get the pre-built image in <a href="https://github.com/webosose/build-webos/releases/tag/v2.24.0">this GitHub address.</a></li><li>You need to flash this image on a micro sd card.</a>.</li></ul></dd>
<dt>Monitor</dt>
<dd>The model we used is a 7-inch Raspberry Pi 1024x600 HDMI touchscreen LCD.</dd>
**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.

### Host PC

Expand All @@ -208,6 +210,17 @@ git clone https://github.com/KNU-LG/backend.git

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

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:

- **PORT**: Port number on which the server will run. Ensure proper port forwarding in your firewall or router.
- **DATABASE_URL**: URL for accessing the PostgreSQL database.
- **PASSWORD_ROUND**: Integer value used for password hashing. A value between 1 and 100 is recommended.
- **JWT_SECRET**: String used for generating JWT tokens. Use a secure and non-obvious value.
- **MAIL_USER**: The email address used for sending emails in the password recovery API. Configuration details are provided below.
- **MAIL_PASSWORD**: The password associated with the email account specified in `MAIL_USER`.

### Email Configuration

The `find_password` API works by sending emails. The following instructions explain how to configure a Gmail account:
Expand Down Expand Up @@ -255,17 +268,6 @@ For more details on the PostgreSQL Docker image, visit the [official documentati

If you prefer not to use Docker, you can set up PostgreSQL locally, but the `DATABASE_URL` environment variable must still ensure proper connectivity.

### Environment Variables

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:

- **PORT**: Port number on which the server will run. Ensure proper port forwarding in your firewall or router.
- **DATABASE_URL**: URL for accessing the PostgreSQL database.
- **PASSWORD_ROUND**: Integer value used for password hashing. A value between 1 and 100 is recommended.
- **JWT_SECRET**: String used for generating JWT tokens. Use a secure and non-obvious value.
- **MAIL_USER**: The email address used for sending emails in the password recovery API. Configuration details are provided below.
- **MAIL_PASSWORD**: The password associated with the email account specified in `MAIL_USER`.

### Install Project Dependencies

After completing all configurations, run the following command to install project dependencies:
Expand Down