severinbeauvais / namex

BC Registries Names Examination, research and approval system API

NameX

BC Registries Names Examination, research and approval system API

Technology Stack Used

• Python, Flask, Flask-restplus, Marshmallow
• Pytest, Pytest-Mock
• Postgres - SQLAlchemy, psycopg2-binary & alembic
• Keycloak
• Solr

Third-Party Products/Libraries used and the the License they are covert by

Project Status

2018-11-01 * changes to solr synonyms 2018-10-19 Release

Documentation

GitHub Pages (https://guides.github.com/features/pages/) are a neat way to document you application/project.

Files in this repository

api        - the core API service

solr       - solr is used as a search service providing advanced semantic support
solr-feeder
solr-synonyms-api

nro-update    - updates the legacy database, used as an integration point for downstream systems
nro-extractor - pulling incoming requests from the legacy systems

nro-legacy    - scripts to manage integration objects with the legacy Oracle DB      

Deployment (Local Development)

• Developer Workstation Requirements/Setup
• Application Specific Setup

Deployment (OpenShift)

See (openshift/Readme.md)

Getting Help or Reporting an Issue

To report bugs/issues/feature requests, please file an issue.

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 2018 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.