Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DigitalNZ/supplejack_api
Supplejack API Mountable Engine
https://github.com/DigitalNZ/supplejack_api
Last synced: about 2 months ago
JSON representation
Supplejack API Mountable Engine
- Host: GitHub
- URL: https://github.com/DigitalNZ/supplejack_api
- Owner: DigitalNZ
- License: gpl-3.0
- Created: 2014-04-15T02:49:45.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-07-17T10:54:31.000Z (3 months ago)
- Last Synced: 2024-07-18T03:24:39.923Z (3 months ago)
- Language: Ruby
- Size: 6.03 MB
- Stars: 17
- Watchers: 9
- Forks: 6
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Supplejack API
The Supplejack API is a [mountable engine](http://guides.rubyonrails.org/engines.html) which provides functionality to store, index and retrieve metadata via an API.
For more information on how to configure and use this application refer to the [documentation](http://digitalnz.github.io/supplejack).
## Installation
[Install & Setup instructions](http://digitalnz.github.io/supplejack/start/development-setup.html)
## Swagger Documentation
[Stories Api](https://swaggerhub.com/api/DigitalNZ/supplejack-stories-api/3.0.0)
## Engine Development
### Rails console
```
cd spec/dummy/
bundle exec rails console
```
### Rails server
```
cd spec/dummy/
bundle exec rails server
```
### Solr
```
cd spec/dummy/
bundle exec rake app:sunspot:solr:start
```
This will start the server based on the configuration in `config/sunspot.yml`
```
cd spec/dummy/
bundle exec rake app:sunspot:solr:stop
```
## Engine Testing
### Rspec Specs
From the root of the engine, run `bundle exec rspec spec/`
This uses `spec/dummy` to mount the engine into and then runs the specs.
## COPYRIGHT AND LICENSING
### MAJORITY OF SUPPLEJACK CODE - GNU GENERAL PUBLIC LICENCE, VERSION 3
Supplejack is a tool for aggregating, searching and sharing metadata records. Supplejack API is a component of Supplejack. Except as indicated below, the Supplejack API code is Crown copyright (C) 2014, New Zealand Government. Supplejack was created by DigitalNZ at the National Library of NZ and the Department of Internal Affairs. http://digitalnz.org/supplejack
Except as indicated below, this program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses / http://www.gnu.org/licenses/gpl-3.0.txt