https://github.com/koopjs/koop-elasticsearch-example-app
An example app that uses the koop-provider-elasticsearch provider
https://github.com/koopjs/koop-elasticsearch-example-app
Last synced: about 1 month ago
JSON representation
An example app that uses the koop-provider-elasticsearch provider
- Host: GitHub
- URL: https://github.com/koopjs/koop-elasticsearch-example-app
- Owner: koopjs
- License: other
- Created: 2022-03-05T09:48:41.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T21:13:03.000Z (over 2 years ago)
- Last Synced: 2025-01-24T10:47:18.307Z (3 months ago)
- Language: JavaScript
- Size: 58.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# koop-cli-new-project
A minimal Koop project template from [Koop CLI](https://github.com/koopjs/koop-cli).
See the [specification](https://koopjs.github.io/docs/usage/koop-core) for more details.
## Configuration
### App Configuration
The Koop application is configured with the [config](https://www.npmjs.com/package/config) package. By default the configurations are stored as JSON files in the `config` folder. It is recommended to namespace the configuration for plugins in order to avoid any potential key conflict.
### Koop Configuration
The Koop project configuration `koop.json` is the configuration for the app/plugin code. It is part of the code and used to store internal properties of the app/plugin. It should not be changed with the deployment.
## Development
### Testing
This project uses [mocha](https://www.npmjs.com/package/mocha) as the testing framework and [chaijs](https://www.chaijs.com/) as the assertion library. All test files in the `test` directory should have the special extension `.test.js`, which will be executed by the command:
```
$ npm test
```
### Dev Server
This project by default uses the [Koop CLI](https://github.com/koopjs/koop-cli) to set up the dev server. It can be invoked via
```
$ npm start
```
The server will be running at `http://localhost:8080` or at the port specified at the configuration.
For more details, check the [Koop CLI documentation](https://github.com/koopjs/koop-cli/blob/master/README.md).