blocks-order-service

Overview

Order service, wrap the business logic of manage orders. Interact with the following Microservices:

• blocks-user-service
• blocks-organization-service
• blocks-catalog-service

Getting started

1. Make sure global yarn is installed (nvm use && npm install -g yarn)

2. Open project folder use VSCode

3. Disable prettier if it cause some error (you can watch in right bottom of your VSCode if any reds, image below). You can use Shift + Command + X and search for it and disable

4. Open ./.vscode/blocks-order-service.code-workspace file, click the Open workspace button in the right bottom place (also see image below)

5. Open project files and you should be able to see all errors resolved

6. Some common used commands:

   • yarn build
   • yarn typecheck
   • yarn test
   • yarn spell-check

🏗 Project Structure

.
├── .github                
├── .husky                 # husky settings - @basaldev/lint-staged-config
├── .vscode                # vscode settings
├── .yarn                  # yarn binary, config and project dependencies
├── coverage *             # jest coverage report
├── dist *
├── docs
│   ├── assets             # documentation related assets
│   └── reference          # api docs
├── src
│   ├── adapter
│   ├── test
│   └── index.ts
├── .eslintignore
├── .eslintrc.js            # @basaldev/eslint-config
├── .gitignore
├── .nvmrc
├── .pnp.cjs                # yarn config
├── .pnp.loader.mjs         # yarn config
├── .prettierignore
├── .prettierrc.json        # @basaldev/prettier-config
├── .yarnrc.yml             # yarn config
├── cspell.config.js        # @basaldev/cspell-config
├── .yarnrc.yml             # yarn config
├── jest.config.js          # @basaldev/jest-preset
├── package.json
├── README.md
├── tsconfig.json           # @basaldev/tsconfig
└── yarn.lock

* Not tracked by git

🔰 Setup

Create a Github Personal Auth Token

1. Go to Github Developer Settings > Personal Tokens > Generate new token
2. Click 'Generate Token'
3. Input a name for your token.
4. Select repo checkbox
5. Select write:packages
6. Add to your local environment - .zshrc .bashrc etc

export BASALDEV_AUTH_TOKEN=__INSERT_YOUR_TOKEN_HERE__

Install NVM

• OSX / Linux
• Windows

Install Yarn (Global)

Yarn must be installed globally for the project's NodeJS version. This should be done so using the command below.

nvm use && npm install -g yarn

Install Husky 🐺

yarn husky install

⚠️ IMPORTANT: Only use the yarn command install or run scripts. Do not use npm run xxx

🪄 Usage

Run typescript compiler

yarn start

Run debug server on default port: 9339.

• Requires yarn start to be running in a separate session
• Port should be updated to avoid conflicts with other projects package.json > scripts > debug

yarn debug

Run unit tests

docker compose up
yarn test

Installing packages

yarn add <package> | yarn add <package> -D

⚡️ Special Notes for VSCode Users

📐 Required Extensions

Please ensure the following extensions are installed:

• arcanis.vscode-zipfs
• dbaeumer.vscode-eslint
• seatonjiang.gitmoji-vscode
• henrynguyen5-vsc.vsc-nvm (optional)

🛠 Workspaces

The kit uses vscode workspaces for vscode project settings:

• All common vscode project settings should be specified in the .vscode/${project_name}-workspace file.
• Personal user settings should be added to .vscode/settings.json (gitignored)
• ⚠️ You must open this project as a workspace in vscode This can be done by clicking the workspace file while in vscode, or by using File > Open workspace from file.

🪛 TypeScript

When prompted asking which typescript VSCode should use, it's very important that you choose the local project version located at .yarn/sdks/typescript/...

💅 Prettier

If you have the prettier extension installed, please disable it for this project. ts-kit uses eslint to execute prettier, so having prettier enabled in vscode will cause conflicts and strange behavior.

🤖 Format on Save (optional)

Add the following code to your .vscode/settings.json will automatically fix all eslint errors whenever you save a file.

  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  }

🚀 Package Deployment

This library uses github registry to publish private npm package. For detailed instructions see here

💡 Note: that npm is used for version & publish commands

1. Bump version

npm version ${VERSION}

2. Build Package

yarn build

3. Publish Package

npm publish --tag=latest | experimental

Then go to github https://github.com/basaldev/backend-sdk/packages to check published packages.