modern-agile-team / create-dev-portfolio Goto Github PK

Description

Update this app to run in deployed environments such as AWS, GCP, and Oracle cloud.

Progress

• Update node version of dockerfile for nodejs to v14.20.1
• Update number of connection for db transaction to 1000.
  • Node
  • MySQL's my.cnf
• Update localhost to each deployed host address, and then Change the host address string to ENVIRONMENT_VARIABLE.
  • React
  • Swagger
  • config/.client.env
  • config/.server.env

This is issue for editing the typeDoc of component.
If you don't know the typeDoc, check the following link: typeDoc Tutorial, typeDoc Official.

Description

Among the descriptions of the components, the newly added component has no description.
Therefore, we add a brief description of the newly added components.

Modification Components

• ProgressBar
• Skill
• Channel

Progress by component

1. ProgressBar

• Add @component and description in ProgressBar typeDoc.
• Add @link in ProgressBar typeDoc.

2. Skill

• Add @component and description in Skill typeDoc.
• Add @link in Skill typeDoc.

3. Channel

• Add @component and description in Channel typeDoc.
• Add @link in Channel typeDoc.

Reference

You need to add descriptions about both steps First and Second in the Components as follows.

First

You must specify the name of the component and add it if you need a brief explanation.

Second

You need to add a @link that can be routed to README.md that can be referenced for the props of the Component.

Expected results

After going through both of the above two steps, you can expect the results below.

❗ Caution

Please write this typeDoc directly above where the component is declared.

Description

Write your description
Need to add typedoc to server api

Progress

• add typedoc to server api

Add required systems

Required systems

Operating System: Linux & MacOS

Windows is also available, but bash terminal is recommended, and the following tools must be operated based on bash.

Tools

1. recommended: Bash terminal
2. required: Docker & Docker-compose
3. node ≥ v14.20.1
   • Using nvm, you can easily change the node version. Please refer to the following: NVM
4. npm ≥ v6.14.17

Description

Write your description
Add typeDoc to server source

Progress

• Add typeDoc to Visitor Count API
• Add typeDoc to Guestbook API

Reference

Description

Please update the color variable name from color to COLOR.
because we think color variable should updated to the static variable name. it should be updated the name to COLOR for developers so that it understandable easier.

Progress

• Update variable names in client/app/src/App.tsx
• Update variable names in client/app/src/common/style/theme.tsx
• Update variable names in client/app/src/common/instroduction/*

Reference

You can check the color variable name the following link :

Fix error that render twice in a row

Description

Applying the auto-generated swagger library

Progress

• Applying the auto-generated swagger library
• Delete existing swagger files
• The HOST_ADDRESS and PORT specified in the .env file must be applied

References for implement

• https://github.com/davibaltar/swagger-autogen

Description

Add database erd to README.md file

Progress

• Add database erd image to README.md file

Add application action script

1. Server shutdown script
   I need a script capable of shutting down docker in the root path when I want to shut down the server.

2. Separation of application scripts by OS
   When 'npm run start:all' is executed, OS-specific scripts must be executed.

Description

Add typedoc to client code

Progress

• ProgressBar
• Skill
• Channel
• Channels
• Remove import the above conponents, and then imported together from the one place where called 'common/indtoduction'

Add .nvmrc file to both client, server, so that NVM can manage the node version.

Reference

• nvm으로 프로젝트별 node.js 버전 관리
• nvm-sh/nvm

Description

Add NODE_ENV into both the server and client so that they can apply the production mode.

Progress

• Update config/.client.env

# If you want to deploy the production, put the "production".
REACT_APP_NODE_ENV="development"

# Client port number to open this react-app.
PORT=3000

# Enter the same value as the PORT environment variable written in .server.env.
REACT_APP_SERVER_PORT=8000 

# Put the IP or host address of the computer you are using.
# The REACT_APP_SERVER_HOST_ADDRESS below only works when REACT_APP_NODE_ENV is "production", otherwise it works as "localhost".
REACT_APP_SERVER_HOST_ADDRESS="localhost"

• Update config/.server.env

# If you want to deploy the production, put the "production".
NODE_ENV="development"

# NodeJS
PORT=8000

# Put the IP or host address of the computer you are using.
# The HOST_ADDRESS below only works when NODE_ENV is "production", otherwise it works as "localhost".
HOST_ADDRESS="localhost" 

# For accessing from Nodejs to MySQL
DB_HOST="db"
DB_USER="root"
DB_PSWORD="password"
DB_DATABASE="dev_portfolio"
DB_PORT=3306

• Update server/app/src/apis/instance.ts so that it can production and otherwise mode

const instance = new HTTP(
  `http://${
    REACT_APP_NODE_ENV === "production"
      ? REACT_APP_SERVER_HOST_ADDRESS
      : "localhost"
  }:${REACT_APP_SERVER_PORT}`
);