bcgov/connectivity-rtp

Intake for application process for BC Connectivity funding program

connectivity-intake

Intake for application process for BC Connectivity funding program

Usage

Clone the repo and run the following commands:

# Install tools required for the project
asdf install
asdf reshim

# Start Postgres database
pg_ctl start

# Create Database
createdb connectivity_intake

# Set up database
cd db
sqitch deploy

# Build and run application
cd ../app
cp .env.example .env # Copy .env.example file
yarn
yarn dev

Docker

To run application using Docker, run the following commands from the root folder:

docker build -f app/Dockerfile -t connectivity-intake:latest .
docker run -p 3000:3000 connectivity-intake:latest

Go to: http://localhost:3000

Run End to End Cypress Test Locally

cd app
yarn
yarn run cypress:open

Environment Variables

Name	Description
NODE_ENV	The back-end run-time's environment. Possible values include either "development" or "production".
PGUSER	The PostgreSQL user to connect to locally.
PGPASSWORD	The PostgreSQL password to connect to locally.
PGDATABASE	The PostgreSQL database name to connect to locally.
PGHOST	The PostgreSQL port to connect to locally.
PGPORT	The PostgreSQL host to connect to locally.
ORIGIN	The root URL of the web app.
SESSION_SECRET	The session secret passed to middleware, defaults to random string
PORT	The port where the app will be served
HOST	The addess of the host where the app is located

connectivity-rtp's Issues

New application landing page

RTP - Questions

Based on data we need to collect, reflected in this Word doc: https://bcgov.sharepoint.com/:w:/r/teams/04708/Shared%20Documents/Data%20and%20mapping/2022-01-10RTP%20Zone%20Form%20Questions.docx?d=wbde7fc679b8f45dfbb5d994e4fbef099&csf=1&web=1&e=ys4nyZ

• Mock up questions for Howard review and approval
• Mock up UX wireframe for how questions will look in form.
• Examine changes from lawyers.
• Create paper/pdf version of instructions/information sheet to accompany form
• Determine how many geomarks are required and where they will be submitted.
• Approval of questions and appearance.

RTP IDIR Integration

Setup CI/CD pipeline

Submission success page

Thank you for submission page

Create confirmation page

As a program applicant
I want an application received confirmation page
so that I can be sure my application has been received

*this page should be made as a mock-up with no real functionality

AC:

• new page with form data displayed before setting "complete status"
• Button to Go back to the form
• Button to "submit" form data (changing status to "complete")
• Form data displayed in the correct areas for user review

Implement End-to-End Testing Framework

As a developer
I want to implement TBD end-to-end testing framework
so that I can begin writing tests to ensure functioning code

AC:

• Implement and configure TBD end-to-end testing framework
• Write at least one passing test
• Tests run with a single command eg. yarn test

Landing Page with Program Info

Program is not named, working with GDX to get URL. The ministers office needs to name it and they have been asked.

Create landing page at placeholder URL with bcgov themed components from toolkit.

Similar to Small and Medium Sized Business Grant page

NDIT Page

Wire-framing?

RTP Application Form

Form to include fields similar to this one from NDIT

Setup docker

As a developer
I want to build and store a docker image
So that I re-use a docker image for testing and deploying the application

AC:

• create DockerFile using cass-ciip as a template
• create github action workflow that builds and publishes the docker image to github packages
• ensure docker image is correctly built and published to github packages

Content for begin/resume application page

Add readme to repo

As a github user
I want to get additional info about the connectivity intake app
so that I can have a better understanding for using and developing on the connectivity app

AC:

• add readme to repo

Persist applicant profile in database

• copy info from page one of the pre-screen application form: https://www.northerndevelopment.bc.ca/funding-programs/partner-programs/connecting-british-columbia/economic-recovery-intake/

• How do you qualify for this program. copy eligibility from FAQ (what are the eligibility requirements for the program)

• multiple questions to ensure applicants qualify

• textbox at the end for notes? (Raj)

Access to namespaces

Work with platform services to get access to the namespaces in place

Create landing page for applicant

As a program applicant
I want to see a landing page once logged in that displays in progress applications, submitted applications, and a new application button
so that I can have my options and information consolidated in one page.

AC:

• new page that display in-progress applications, submitted applications, and a new application button
• screenshot and share to Miro board for customer review

Descriptive naming for styled components

Refine current sample landing page

As a respondent
I want to see a landing page after I log in
so that I be confident in where I am in the RTP.

• implement design as per miro board.

Lets use common phrasing

TL;DR 🏎️

Teams are encouraged to favour modern inclusive phrasing both in their communication as well as in any source checked into their repositories. You'll find a table at the end of this text with preferred phrasing to socialize with your team.

Words Matter

We're aligning our development community to favour inclusive phrasing for common technical expressions. There is a table below that outlines the phrases that are being retired along with the preferred alternatives.

During your team scrum, technical meetings, documentation, the code you write, etc. use the inclusive phrasing from the table below. That's it - it really is that easy.

For the curious mind, the Public Service Agency (PSA) has published a guide describing how Words Matter in our daily communication. Its an insightful read and a good reminder to be curious and open minded.

What about the master branch?

The word "master" is not inherently bad or non-inclusive. For example people get a masters degree; become a master of their craft; or master a skill. It's generally when the word "master" is used along side the word "slave" that it becomes non-inclusive.

Some teams choose to use the word main for the default branch of a repo as opposed to the more commonly used master branch. While it's not required or recommended, your team is empowered to do what works for them. If you do rename the master branch consider using main so that we have consistency among the repos within our organization.

Preferred Phrasing

Non-Inclusive		Inclusive
Whitelist	=>	Allowlist
Blacklist	=>	Denylist
Master / Slave	=>	Leader / Follower; Primary / Standby; etc
Grandfathered	=>	Legacy status
Sanity check	=>	Quick check; Confidence check; etc
Dummy value	=>	Placeholder value; Sample value; etc

Pro Tip 🤓

This list is not comprehensive. If you're aware of other outdated nomenclature please create an issue (PR preferred) with your suggestion.

Select zones you wish to apply for

• guidelines at the top for selecting zones

• check boxes for all 13 zones

• button to proceed to geomark info

Login using BCeID

Add project lifecycle badge

No Project Lifecycle Badge found in your readme!

Hello! I scanned your readme and could not find a project lifecycle badge. A project lifecycle badge will provide contributors to your project as well as other stakeholders (platform services, executive) insight into the lifecycle of your repository.

What is a Project Lifecycle Badge?

It is a simple image that neatly describes your project's stage in its lifecycle. More information can be found in the project lifecycle badges documentation.

What do I need to do?

I suggest you make a PR into your README.md and add a project lifecycle badge near the top where it is easy for your users to pick it up :). Once it is merged feel free to close this issue. I will not open up a new one :)

Cypress testing on CI

As a developer
I want to have cypress run using github actions when push to a branch
so that I can have tests run automatically

AC:

• cypress runs using cypress github action
• runs using docker image

Applicant Authentication

BCeID

Legal Disclaimer

Application received confirmation page

A page for confirming an application has been received by gov. This page should contain a confirmation number, re-engagement timeline, and links for a new application and returning home.

Taxonomy for eligibility questions

Add missing topics

TL;DR

Topics greatly improve the discoverability of repos; please add the short code from the table below to the topics of your repo so that ministries can use GitHub's search to find out what repos belong to them and other visitors can find useful content (and reuse it!).

Why Topic

In short order we'll add our 800th repo. This large number clearly demonstrates the success of using GitHub and our Open Source initiative. This huge success means it's critical that we work to make our content as discoverable as possible. Through discoverability, we promote code reuse across a large decentralized organization like the Government of British Columbia as well as allow ministries to find the repos they own.

What to do

Below is a table of abbreviation a.k.a short codes for each ministry; they're the ones used in all @gov.bc.ca email addresses. Please add the short codes of the ministry or organization that "owns" this repo as a topic.

That's it, you're done!!!

How to use

Once topics are added, you can use them in GitHub's search. For example, enter something like org:bcgov topic:citz to find all the repos that belong to Citizens' Services. You can refine this search by adding key words specific to a subject you're interested in. To learn more about searching through repos check out GitHub's doc on searching.

Pro Tip 🤓

• If your org is not in the list below, or the table contains errors, please create an issue here.

• While you're doing this, add additional topics that would help someone searching for "something". These can be the language used javascript or R; something like opendata or data for data only repos; or any other key words that are useful.

• Add a meaningful description to your repo. This is hugely valuable to people looking through our repositories.

• If your application is live, add the production URL.

Ministry Short Codes

Short Code	Organization Name
AEST	Advanced Education, Skills & Training
AGRI	Agriculture
ALC	Agriculture Land Commission
AG	Attorney General
MCF	Children & Family Development
CITZ	Citizens' Services
DBC	Destination BC
EMBC	Emergency Management BC
EAO	Environmental Assessment Office
EDUC	Education
EMPR	Energy, Mines & Petroleum Resources
ENV	Environment & Climate Change Strategy
FIN	Finance
FLNR	Forests, Lands, Natural Resource Operations & Rural Development
HLTH	Health
IRR	Indigenous Relations & Reconciliation
JEDC	Jobs, Economic Development & Competitiveness
LBR	Labour Policy & Legislation
LDB	BC Liquor Distribution Branch
MMHA	Mental Health & Addictions
MAH	Municipal Affairs & Housing
BCPC	Pension Corporation
PSA	Public Service Agency
PSSG	Public Safety and Solicitor General
SDPR	Social Development & Poverty Reduction
TCA	Tourism, Arts & Culture
TRAN	Transportation & Infrastructure

NOTE See an error or omission? Please create an issue here to get it remedied.

Company profile draft flow

Create a form flow for creating a company profile within the application

https://miro.com/app/board/uXjVOY6rC94=/

Definition of Done

Determine the definition of done for all tickets in the Connectivity Intake app

• Have team discussion about definition of done
• Create team agreement documentation and store in repo

Implement Visual Regression Testing Framework

As a developer
I want to implement a visual regression testing framework
so that I can be sure the visual changes I make to the code doesn't break anything visually

AC:

• Implement and configure TBD visual testing framework
• Write at least one passing test
• Tests run with a single command eg. yarn test

Case Conflicts

The [email protected] package has case conflicts that prevent it's use on a case-insensitive filesystem (eg. OSX). This package needs to be rebuilt with consistent case folder and file names that are not in conflict with each other.

Related #54

Implement Unit Testing Framework

As a developer
I want to implement TBD unit testing framework
so that I can begin writing tests and ensuring code is functioning correctly

AC:

• Implement and configure TBD testing framework
• Write at least one passing test
• Test is run with a single command eg. yarn test

Add an Apache 2.0 License

Get access to BCGov Org on GitHub

We need to add Raj and John to the BCGov Org before we can add them to the repo.

Applicant Authentication

Determine Testing Frameworks

As a developer
I want to determine testing frameworks used in the application
so that I can begin setting up and writing tests for the application

AC:

• Determine framework for unit testing
• Determine framework for end-to-end testing
• Determine framework for regression testing

Technical Debt

Naming conventions for styled components

Team agreement for branching

As a developer
I want a clear branching model agreement
so that I can effectively and precisely contribute to the app

AC:

• team agreement in docs/team_agreements directory

Content for begin/resume application page

Should support UX of application process:

• who should be filling out this form
• how long will it take to apply to the program
• what information will be needed to complete
• what happens if they lose username/password
• that they can start/come back to form
• dates/deadlines for completion of application
• timeline on gov response to applicants
• how information will be used
• any legal stuff

Definition of Ready

Determine the definition of ready for all tickets in the Connectivity Intake app

• Have team discussion about definition of ready
• Create team agreement documentation and store in repo

Boilerplate application code

There are boilerplate examples of successful nextjs applications that can be copied and re-used.

• Determine which example we wish to use
• Copy code and push to repo
• Test application

User flow for applicant

Create a user flow for submitting an RTP thru the app

Select project type

I am interested in:

• Community projects (last mile)
• Backbone projects
• Cellular

Details for project type

• Named communities (# households)
• FN communities (# households)
• Highway miles per zone (w and w/out power)

Applicant landing page

Deploy sample application

Deploy a sample application with form and in BC colours

Upload KMZ file to email

we can import zones if we use postgis on posgres https://postgis.net/docs/ST_GeomFromKML.html

Boilerplate pipeline code

There are boilerplate examples of successful pipelines that can be copied and re-used.

• Collect list of examples
• Evaluate examples for conformance with best practices
• Determine which example we wish to use
• Copy code and push to repo
• Test deployment

Automated Testing

As a developer
I want to have automated testing frameworks used in the application
so that I can run tests to ensure only good quality working code is brought into the code base.