Discovery portal for Peppermint.
See Peppermint.
- Install docker-compose
- Clone Peppermint and this repo under the same directory.
- Run using Peppermint's docker-compose.yml:
docker-compose up - Navigate to
http://localhost:9001/peppermint/
- Clone a pre-built version of this project:
git clone -b dev_build https://github.com/redbox-mint/peppermint-portal.git - Configure your web server to serve
peppermint-portal/build/peppermint/directory as/peppermint/path. Also, because the portal is a SPA, update your web server configuration to try to serve thepeppermint-portal/build/index.htmlfor most routes. See this sample config line for NGINX. - Update your
build/peppermint/assets/config.jsonso it can query your search index of choice.
- Modify translation file
- Application has SASS support. Please update styles.scss
- Modify config file
| Config key | Description |
|---|---|
| recordTypes | The available record types for discovery / query. The key value corresponds to the search-<recordType> in the translation file. Also, it corresponds to the record type config described below. |
recordType |
The record type block configuration. |
| defaultSearchResult | Array of lines that is executed as part of displaying a search result. |
You will need to set up your development environment for these changes. See "Developing" section below.
- For HTML header, script, CSS, etc.: modify index.html
- For main search header/footer/main interface component modify the main component
- For search bar interface/refiner UI, edit the appropriate component under src/app/components
- Node 10.16.0 or greater installation. We recommend using nvm to manage your Node installations.
- Run as "Quick set up" above, but instead of using the
dev_buildbranch, use the branch you want to develop against. - Then on the repo directory, run
npm run-script build_dev_watch - Editing the files on the repo, will rebuild the bundled files and sync it to the docker container.