🚧 🚧 🚧 THIS PROJECT HAS AN EXPERIMENTAL STATUS, DON'T USE IT 🚧 🚧 🚧

 

@kode-frontend/pathfinder-web-core

Installation | Development | Release flow

 

This is the core library for pathfinder-web-react. There is no need to install it as a separate package, Pathfinder pulls it up through dependencies.

Pathfinder is a tool for changing base URL for API requests on the client side. Read more.

Pathfinder-web-core is isolated into an individual package for the possibility of its reuse by other platforms, for example, React Native. It is easy to integrate and it does not require any further development.

Installation

npm i @kode-frontend/pathfinder-web-core

# or using yarn
yarn add @kode-frontend/pathfinder-web-core

Development

Release

Releases are made using Release-it CLI tool.

Local release:

1. Generate your personal access token with 'api' scope.
2. Run:

GITLAB_TOKEN=your-personal-access-token npm run release

# or using yarn
GITLAB_TOKEN=your-personal-access-token yarn release

Publish to npm:

npm publish --access public

# or using yarn
yarn publish --access public

TODO

• [x] add tests
• [ ] add gitlab CI quality pipeline
• [ ] add gitlab CI release pipeline
• [x] add project docs and description

License

MIT ©