docs: update enviroment requirement

This commit is contained in:
alt0 2022-10-19 18:10:20 +08:00
parent 2fda9c39e9
commit e59a859bed

View File

@ -1,14 +1,38 @@
# Pathfinder
## Prerequisites
- Git
- Node: any 12.x version starting with v12.0.0 or greater
- Pnpm: See [how to installation](https://pnpm.io/installation)
## Development
```
pnpm dev
```
Open https://localhost:3000 in browser.
## Build
```
pnpm build
```
### Replace Modules
You can create `module-resolve.js` in project root dir to replace some package to better implements. Example:
You can create `module-resolve.js` in project root dir to replace some package to better implements.
There is a template file in `scripts/module-resolve/module-resolve.tmpl.js`.
Example:
```
function resolve(pkg) {
if (pkg.dependencies && pkg.dependencies['@toeverything/track']) {
pkg.dependencies['@toeverything/track'] = '^0.0.1';
if (pkg.dependencies && pkg.dependencies['@toeverything/pathfinder-logger']) {
pkg.dependencies['@toeverything/pathfinder-logger'] = '^0.0.1';
}
return pkg;