MapWorld

• Introduction
• Initialize Develop Environments
  • Preparation
    • Mandatory
    • Strongly Recommendation
  • Installation
  • Initialize VSCode
  • Push your code

Introduction

WIP

Initialize Develop Environments

Preparation

Mandatory

• install nvm, toggle automatically call nvm use, or use nvm install node.js 12.14 or later
• install yarn 1.21 or later

Strongly Recommendation

• VSCode (Although use other editors, VSCode is needed to consist team collaboration)
• SourceTree (Makes up for the editors' ability to view and compare version histories. Note that the first time you run it, you need to register a bitbucket account to activate the software)
• iTerm2
  • enable Status Bar
  • iTerm Color Schemes
• oh-my-zsh
  • spaceship
  • Powerline fonts
  • zsh-better-npm-completion

Installation

After cloned this project, you need to execute the following command, which would install all the dependencies.

# run at root of this project
yarn setup

After all modules installed, you can build and run the application

yarn build

yarn start

or run and watch changes

yarn dev

or package it

# mac
yarn package

# windows
yarn package-win

# linux
yarn package-linux

# all platforms
yarn package-all

Initialize VSCode

Then you should see a pop-up message box, it is suggested that some VSCode plug-in installation (you can enter the plugins panel from the left side of the toolbar, the points in the upper right corner to select "Show Recommended Extensions" to install the plugins), in the "Workspace Recommendations" in the title bar, click "Install All Workspace Recommended Extensions", confirm each plugin is the enable state, restart VSCode

Confirm Development Environments

If these steps in front of the right to carry out, open any JS or TS file, ESLint should be displayed lower right corner (no warning icon), the PROBLEMS panel will display the current open file error and warning information, write some inconsistent layout code and save automatically generating code in conformity with the specification (and sometimes need to save many times to complete automatic repair all code)

Push your code

SourceTree must be installed, before committing your code, you should review your code first, compare the current state with the last steady state in history in SourceTree (such as latest master status), make sure all of changes in the commits are your expectations

Commit Message

All commit messages conform to Conventional Commits Specification（type）

Run the following command, and follow the tips to finish commit:

yarn cz

Others

The VSCode settings is common to all project developers and has a higher priority than individual settings and cannot be modified