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

doc:📝 add starting the project and socket endpoint #361

Merged
merged 4 commits into from
Jan 14, 2024

Conversation

JohnsonMao
Copy link
Contributor

@JohnsonMao JohnsonMao commented Nov 29, 2023

Why need this change? / Root cause:

  • Enable backend personnel to run the frontend project locally

Changes made:

  • Add starting the project doc
  • Add web socket endpoint environment variables
  • Modify socket context

Test Scope / Change impact:

Issue

Starting the Project

如何在自己的本地跑前端專案,並連接 webSocket

node 版本需 16.17.0

# 調整 .env.development file 
# 後端 RESTful API 的 url
NEXT_PUBLIC_INTERNAL_ENDPOINT=
# 後端 Socket 的 url
NEXT_PUBLIC_INTERNAL_SOCKET_ENDPOINT=
# 取消前端 Mock Data
NEXT_PUBLIC_MOCK=false
# 使用 yarn install dependencies
# 如果出現 Error 可以改成使用 yarn install 下載
yarn
# 啟動專案
yarn dev

@JohnsonMao JohnsonMao added the documentation Improvements or additions to documentation, ex, storybook, readme label Nov 29, 2023
@JohnsonMao JohnsonMao self-assigned this Nov 29, 2023
Copy link

@kuoche1712003 kuoche1712003 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@GaaSBot
Copy link

GaaSBot commented Dec 23, 2023

Knip Scan Result for 9ab7518

Unused files (9)
Unused files (9)
.bundlewatch.config.js
components/shared/Chat/ChatContent.tsx
components/shared/Chat/ChatMessage.tsx
components/shared/Chat/index.tsx
configs/i18nConfigs.ts
lighthouserc.js
reset.d.ts
scripts/knipScanReporter.js
scripts/lhciScanReporter.js
Unused dependencies (2)
Unused dependencies (2)
@svgr/webpack package.json
sharp package.json
Unused devDependencies (5)
Unused devDependencies (5)
@actions/github package.json
@octokit/core package.json
@storybook/blocks package.json
@storybook/testing-library package.json
@total-typescript/ts-reset package.json
Unused exported types (2)
Unused exported types (2)
ChatProps type components/shared/Chat/v2/Chat.tsx
ChatHeaderProps type components/shared/Chat/v2/ChatHeader.tsx
Configuration issues (1)
Configuration issues (1)
Unused item in ignoreDependencies: @next/bundle-analyzer

@GaaSBot
Copy link

GaaSBot commented Dec 23, 2023

🤖 Lighthouse Scan Result for 9ab7518

/rooms
Metric Value
Performance 73
Seo 78
Accessibility 78
HTML Report for LHCI Scan Report Link
/rooms/abc
Metric Value
Performance 76
Seo 78
Accessibility 64
HTML Report for LHCI Scan Report Link
/login
Metric Value
Performance 47
Seo 80
Accessibility 94
HTML Report for LHCI Scan Report Link

@mikaeloduh mikaeloduh self-requested a review January 14, 2024 14:02
@JohnsonMao JohnsonMao merged commit 5b2d02b into main Jan 14, 2024
@JohnsonMao JohnsonMao deleted the doc/starting-the-project branch January 14, 2024 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation, ex, storybook, readme
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc: frontend setup and web socket testing documentation - 5 point
5 participants