phantom-marmiton/README.md

19 lines
420 B
Markdown

# Marmiton Search
this phantom aim to search in the [marmiton](https://www.marmiton.org) website
## starting the project
checkout this repo and go to root directory
launch `npm i`
launch `npm run test` to ensure all test pass
to auto-transpile launch `npm run watch`
to auto-deploy on build launch `npm run auto-deploy`
to test with online instance launch `npm run online`
want some [docs](./docs/modules.md) ?