From 812c2a5f5e4cb73f092e00f16b8cc62be5bfa8d4 Mon Sep 17 00:00:00 2001 From: Derek Roberts Date: Wed, 12 May 2021 09:22:41 -0700 Subject: [PATCH 1/2] README - remove reference-style links (bot trouble) --- README.md | 25 ++++++------------------- 1 file changed, 6 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index a0d6985..54d05c2 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,11 @@ - -[![Contributors][contributors-shield]](/../../graphs/contributors) -[![Forks][forks-shield]](/../../network/members) -[![Stargazers][stars-shield]](/../../stargazers) -[![Issues][issues-shield]](/../../issues) -[![MIT License][license-shield]](/LICENSE.txt) -[![Lifecycle][lifecycle-shield]](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md) +[![Contributors](https://img.shields.io/github/contributors/ActionAnalytics/containerization-and-cloud-economic-model.svg?style=for-the-badge)](/../../graphs/contributors) +[![Forks](https://img.shields.io/github/forks/ActionAnalytics/containerization-and-cloud-economic-model.svg?style=for-the-badge)](/../../network/members) +[![Stargazers](https://img.shields.io/github/stars/ActionAnalytics/containerization-and-cloud-economic-model.svg?style=for-the-badge)](/../../stargazers) +[![Issues](https://img.shields.io/github/issues/ActionAnalytics/containerization-and-cloud-economic-model.svg?style=for-the-badge)](/../../issues) +[![MIT License](https://img.shields.io/github/license/ActionAnalytics/containerization-and-cloud-economic-model.svg?style=for-the-badge)](/LICENSE.txt) +[![Lifecycle](https://img.shields.io/badge/Lifecycle-Stable-97ca00?style=for-the-badge)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
@@ -209,13 +206,3 @@ Distributed under the MIT License. See [LICENSE.txt](LICENSE.txt) for more infor - [Common Forms Toolkit (ComForT)](https://github.com/bcgov/common-forms-toolkit) - [othneildrew's Best README Template](https://github.com/othneildrew/Best-README-Template) - [shields.io](https://shields.io) - - - - -[contributors-shield]: https://img.shields.io/github/contributors/ActionAnalytics/containerization-and-cloud-economic-model.svg?style=for-the-badge -[forks-shield]: https://img.shields.io/github/forks/ActionAnalytics/containerization-and-cloud-economic-model.svg?style=for-the-badge -[stars-shield]: https://img.shields.io/github/stars/ActionAnalytics/containerization-and-cloud-economic-model.svg?style=for-the-badge -[issues-shield]: https://img.shields.io/github/issues/ActionAnalytics/containerization-and-cloud-economic-model.svg?style=for-the-badge -[license-shield]: https://img.shields.io/github/license/ActionAnalytics/containerization-and-cloud-economic-model.svg?style=for-the-badge -[lifecycle-shield]: https://img.shields.io/badge/Lifecycle-Stable-97ca00?style=for-the-badge From 3253a34fa47d55b3fa0ad7164b202902fc147044 Mon Sep 17 00:00:00 2001 From: Derek Roberts Date: Wed, 12 May 2021 09:22:56 -0700 Subject: [PATCH 2/2] README - cleanup comments and spacing --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 54d05c2..659a163 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,9 @@ [![MIT License](https://img.shields.io/github/license/ActionAnalytics/containerization-and-cloud-economic-model.svg?style=for-the-badge)](/LICENSE.txt) [![Lifecycle](https://img.shields.io/badge/Lifecycle-Stable-97ca00?style=for-the-badge)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md) + +

@@ -21,7 +23,9 @@

+ +

Table of Contents
    @@ -47,6 +51,7 @@
+ ## About The Project A model for analyzing the business case to move from a legacy waterfall on-premise application hosting model to an agile open-source pipeline moving from a staging ground that is containerized on-premise to eventual commercial cloud hosted. @@ -55,14 +60,17 @@ A Vue Frontend (single page application) asks questions which are used to comple This project started as a fork of the Common Services Team's [Common Forms Toolkit](https://github.com/bcgov/common-forms-toolkit). + ### Sample: DEV Mode Sensitivity Analysis Options ![Questions](.images/questions.png) + ### Architecture ![CEM Architecture](.images/overview.png) + ### Built With Technologies: @@ -77,7 +85,6 @@ Services: - [Common Document Generation Service (CDOGS)](https://bcgov.github.io/common-document-generation-service) - [Common Hosted Email Service (CHES)](https://bcgov.github.io/common-hosted-email-service) - ## Getting Started @@ -89,6 +96,7 @@ Windows Substem for Linux v2 is **strongly recommended** for Windows development - [Windows Subsystem for Linux Installation (Windows Only)](https://docs.microsoft.com/en-us/windows/wsl/install-win10) + ### Common Services Access Token (GETOK) Common Services provides various APIs for used by the Government of British Columbia. Please see their project documentation to receive a client ID and secret. @@ -97,6 +105,7 @@ Common Services provides various APIs for used by the Government of British Colu - [Request Account](https://getok.nrs.gov.bc.ca/app/requestAccount) - [My Applications](https://getok.nrs.gov.bc.ca/app/myApps) + ### Run in Docker Compose This is the recommended development method. When running Vue and nodemon will live reload the application as code is modified. @@ -129,6 +138,7 @@ This is the recommended development method. When running Vue and nodemon will li - [Frontend (localhost:8080)](http://localhost:8080) - [Backend (localhost:3000)](http://localhost:3000) + ### Alternative Installation - Local Although a much less consistent and predictable development experience the application can be run on bare-metal with Node.js. Vue and nodemon live reloading remains present. In place of the `docker-compose up` step: @@ -151,13 +161,11 @@ Although a much less consistent and predictable development experience the appli npm run serve ``` - ## Roadmap See the [open issues](/../../issues) for a list of proposed features (and known issues). - ## Contributing @@ -186,19 +194,16 @@ Contributions are what make the open source community such an amazing place to b 5. Open a Pull Request online - ## Code of Conduct Be inclusive and respectful. More information is available in [CONDUCT.md](CONDUCT.md). - ## License Distributed under the MIT License. See [LICENSE.txt](LICENSE.txt) for more information. - ## Acknowledgements