Skip to content
This repository has been archived by the owner on Dec 31, 2020. It is now read-only.
/ searchgate Public archive

A GraphQL-based search aggregator for performing searches across multiple search backends.

License

Notifications You must be signed in to change notification settings

bcgov/searchgate

Repository files navigation

Search Gate

A graphql search federation api

Technology Stack Used

  • Apollo

Project Status

Active

Structure

.
├── config
├── constants
├── datasources
├── docs
└── openshift

Interacting with the API

To test this api locally it is beneficial to have a graphql playground which visualizes queries (much better than running inline curl commands. Graphql Playground

Run Locally

  1. git clone project
  2. cd into working directory and run npm install
  3. copy env vars cp .env.example .env and fill in with appropriate credentials
  4. npm install

Deployment (OpenShift)

This application was built using the bcdk and the pipeline cli

The application is built using a PR based workflow. Every PR kicks off a job in Jenkins that produces a new developer environment that you may subsequently promote into production.

To create this pipeline you may take a look at bcdk and more specifically, the jenkins and jenkins-job script generators.

To trigger builds or deploys from your machine:

  • ensure your have a PR made in github
  • cd .pipeline && npm install

To Build: npm run build -- --pr=<prNum>

To Deploy: `npm run deploy -- --pr= --env=<dev|test|prod>

If you require clarity on what is actually happening during these npm scripts take a look at the build and deploy files found in lib

How to Contribute

If you would like to contribute, please see our CONTRIBUTING guidelines.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

Copyright 2019 Province of British Columbia

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

About

A GraphQL-based search aggregator for performing searches across multiple search backends.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published