search

bcgov / reggie

This is a tool to register for and invite user to bcgov self-serve applications through keyCloak SSO
Apache License 2.0
2 stars 0 forks source link

readme

description: Reggie introduction topics:

About

Reggie is an application to register for and invite user to BCGov Rocket.Chat. Please refer to user instructions to join the chat community.

Usage

Local Development

  1. make sure you have the .env file in both web and api folder, required contents can be found in .env.sample
  2. in ./api: 
    npm i # install dependency
npm run dev # to host the reggie API server
  3. in ./web: 
    npm i # install dependency
npm run start # to host the frontend
  4. publish the host for KeyCloak to redirect 
    npx ngrok http 3000

Deployment (OpenShift)

Project is using a Nodejs based pipeline here OpenShift configuration/templates here

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.

Issues/Suggestions

Make Suggestions/Issues here! Issues are markdown supported.

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.