Welcome to jds-project 👋

Typescript React + Node

Install

Apps required (skip if already installed in your workstation)

1. NodeJS

2. Git Bash

3. Python from Microsoft Store (for yarn)

4. Visual Studio Build Tools

5. Lerna package

6. Postgres. References below:

   • https://www.postgresql.org/download/linux/ubuntu/
   • https://www.postgresqltutorial.com/postgresql-getting-started/install-postgresql-linux/

7. Create postgres user with default password 123

yarn add global lerna

7. on root folder run to install packages:

yarn bootstrap

8. on root folder run to install packages:

yarn start

9. (Optional) On VSCode. install the following extensions:

   • Prettier
   • ESLint

Usage

yarn start

Publish new version

yarn publish:version [major | minor | patch | prerelease]

App theme config

Font family and color palette to be configure here.

MUI theme file

Note

.env file location

jds-project/

.env format

GITHUB_AUTH=<github auth api key for lerna version> Generated from Github settings

.env sample usage

GITHUB_AUTH=123456

.env format each package

Frontend package

Backend package

Branch naming and commit message (MUST FOLLOW)

Types

• feat - new/additional features.
• fix - improvement/bug fix on existing features.
• tech - refactor code, etc.

Branch naming

<type>/<title>

Ex.

feat/dashboard
feat/login
fix/dashboard
fix/login
fix/login-performance
tech/user-input

Commit messages

To easily generate changelog we must follow branch naming as per below:

<type>(<title>): <Description>

Ex.

// new features
feat(dashboard): improved UI.
feat(login): added login UI.

// bug fixing
fix(dashboard): Bug fix.
fix(login): improve performance login.

// refactor or etc.
tech(user-input): refactor debounce.

Packages

Path

jds-project/packages/

backend

• Backend server for jds-project

frontend

• Frontend UI for jds-project

common

• Shared types between backend and frontend. Mostly used to API response data types.

Author

• Website: https://github.com/rem029
• Github: @rem029