kuju63 / SSW.Rules

Generator for ssw.com.au/rules

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SSW.Rules

v2 of the Rules.

This is a Gatsby generated site pulling data from:

Getting Started

Required Tools

Getting ready for development

  • Clone the repo from https://github.com/SSWConsulting/SSW.Rules
  • Run yarn install to install packages
  • Create environment files (.env.development and .env.production) and ask a member of the SSW.Rules team (@pierssinclairssw, @bradystroud) for the values of the following keys:
GOOGLE_ANALYTICS=#{GOOGLE_ANALYTICS}
RECAPTCHA_KEY=#{RECAPTCHA_KEY}
CONTACT_API=#{CONTACT_API}
VERSION_DEPLOYED=#{VERSION_DEPLOYED}
APPINSIGHTS_INSTRUMENTATIONKEY=#{APPINSIGHTS_INSTRUMENTATIONKEY}
CONTENT_BRANCH=#{CONTENT_BRANCH}
AUTH0_CLIENT_ID=#{AUTH0_CLIENT_ID}
AUTH0_DOMAIN=#{AUTH0_DOMAIN}
AUTH0_REDIRECT_URI=#{AUTH0_REDIRECT_URI}
API_BASE_URL=#{API_BASE_URL}

Development

  1. Branch off main for your PBI
  2. Install the recommended extensions if using VS Code
  3. Do your work
  4. Run the site in development mode by yarn develop (.env.development is required for this step)
  5. Commit code and push
  6. Raise a PR
  7. Get it merged!

recommended extensions notification Figure: VS Code recommended extensions notification

Definition of Done

  • Code Compiles
  • Check the Acceptance Criteria.
  • Code is squash-merged to main via a pull request that was approved by a 2nd developer.
  • Another team member agrees it’s ready for Production.
  • Pushed to Production.
  • Use @Mention (OR Send email) to notify Product Owner/PBI stakeholder that PBI is done (be sure to include screenshots/done video as proof)

<As per rule: Done - Do you go beyond 'Done' and follow a 'Definition of Done'?>

Branches

  • Branching strategy is based off Release Flow
  • Main is the main 'dev' branch
  • Release/xx is the 'production' one (where xx is the Sprint number)
  • Always create a new branch for your PBIs
  • Always delete your branch once your PR has been merged

Builds

Rules repository

Rules repository lives here: https://github.com/SSWConsulting/SSW.Rules.Content

Merging changes to main on this repo will trigger:

About

Generator for ssw.com.au/rules

License:MIT License


Languages

Language:JavaScript 72.9%Language:CSS 25.8%Language:PowerShell 1.3%