zimfuzzysearch03 v0.1.7

Fuzzy Search ZIM + Highlighting

Useful Links

• https://medium.com/@jchiam/publishing-a-typescript-react-component-to-npm-d3cc15b8d0a2
• https://itnext.io/step-by-step-building-and-publishing-an-npm-typescript-package-44fe7164964c

Create react app and useful stuff:

• https://github.com/wmonk/create-react-app-typescript/blob/master/template/README.md#publishing-components-to-npm

Important Scripts

npm run npm:build

# login to npm before
npm login

# apply new version
npm version x.y.z

# then publish to npmjs 
npm publish

Installation

• Clone repo
• inside the root (where the package.json is) run:

npm i

• this will install all required dependencies declared in package.json

Development

npm start

• starts the development server

Build / Production

npm build

• builds the application

Deployment

• atm the app is deployed on github pages via pushing it to the gh-pages branch at https://github.com/zimFrontendCoordination/zimFrontendDocuClient