feature/80-i18next-implementation

.github/ISSUE_TEMPLATE/config.yml

@@ -1,13 +1,13 @@
 blank_issues_enabled: true
 contact_links:
   - name: Contributing guidelines
-    url: https://github.com/input-output-hk/voltaire-era/blob/master/CONTRIBUTING.md
+    url: https://github.com/IntersectMBO/govtool/blob/master/CONTRIBUTING.md
     about: Some rules & processes we honor.
 
   - name: Feature ideas
-    url: https://github.com/input-output-hk/voltaire-era/discussions/categories/ideas
+    url: https://github.com/IntersectMBO/govtool/discussions/categories/ideas
     about: Maybe someone else had the same or a similar idea already?
 
   - name: All issues
-    url: https://github.com/input-output-hk/voltaire-era/issues
+    url: https://github.com/IntersectMBO/govtool/issues
     about: Check whether your issue is not already covered here.

.github/ISSUE_TEMPLATE/feature_idea.yml

@@ -8,7 +8,7 @@ body:
       value: |
         **Thank you for contributing to our project!** :green_heart:
 
-        Instead of opening this issue, consider [starting a new idea discussion](https://github.com/input-output-hk/voltaire-era/discussions/new?category=ideas).
+        Instead of opening this issue, consider [starting a new idea discussion](https://github.com/IntersectMBO/govtool/discussions/new?category=ideas).
         That way, we can discuss & refine your idea together, before we adopt it as a feature into the roadmap.
 
   - type: textarea

.github/pull_request_template.md

@@ -1,17 +1,12 @@
 ## List of changes
 
-Please include a summary of the changes and the related issue.
-
-- I created a blue button
-- When pressed the button turns purple 
+- Added / Fixed / Changed / Removed
 
 ## Checklist
 
-- [ ] My code follows the style guidelines of this project
-- [ ] I have performed a self-review of my code
-- [ ] I have commented my code, particularly in hard-to-understand areas
-- [ ] I have made corresponding changes to the documentation
-- [ ] My changes generate no new warnings
-- [ ] I have added tests that prove my fix is effective or that my feature works
-
-## Screenshots of change (for FE)
+- [related issue](https://github.com/IntersectMBO/govtool/issues/)
+- [] My changes generate no new warnings
+- [] My code follows the [style guidelines](https://github.com/IntersectMBO/govtool/tree/main/docs/style-guides) of this project
+- [] I have commented my code, particularly in hard-to-understand areas
+- [] I have made corresponding changes to the [changelog](https://github.com/IntersectMBO/govtool/blob/main/CHANGELOG.md)
+- [] I have added tests that prove my fix is effective or that my feature works

.github/workflows/build-and-deploy.yml

@@ -7,9 +7,8 @@ on:
       cardano_network:
         required: true
         type: choice
-        default: "preprod"
+        default: "sanchonet"
         options:
-          - "preprod"
           - "sanchonet"
       environment:
         required: true
@@ -24,10 +23,14 @@ on:
         required: true
         type: boolean
         default: false
+      resync_cardano_node_and_db:
+        required: true
+        type: boolean
+        default: false
 
 env:
   ENVIRONMENT: ${{ inputs.environment || 'dev' }}
-  CARDANO_NETWORK: ${{ inputs.cardano_network || 'preprod' }}
+  CARDANO_NETWORK: ${{ inputs.cardano_network || 'sanchonet' }}
 
 jobs:
   check_environment_exists:
@@ -120,6 +123,7 @@ jobs:
       GRAFANA_ADMIN_PASSWORD: ${{ secrets.GRAFANA_ADMIN_PASSWORD }}
       GRAFANA_SLACK_RECIPIENT: ${{ secrets.GRAFANA_SLACK_RECIPIENT }}
       GRAFANA_SLACK_OAUTH_TOKEN: ${{ secrets.GRAFANA_SLACK_OAUTH_TOKEN }}
+      NGINX_BASIC_AUTH: ${{ secrets.NGINX_BASIC_AUTH }}
       SENTRY_DSN_BACKEND: ${{ secrets.SENTRY_DSN_BACKEND }}
       TRAEFIK_LE_EMAIL: "admin+vva@binarapps.com"
     steps:
@@ -141,10 +145,17 @@ jobs:
           ssh-private-key: ${{ secrets.GHA_SSH_PRIVATE_KEY }}
       - name: Prepare and upload app config
         run: |
-          make prepare-config
           if [[ "${{ inputs.environment }}" == "staging" ]]; then export DOMAIN=staging.govtool.byron.network; fi;
           if [[ "${{ inputs.environment }}" == "beta" ]]; then export DOMAIN=sanchogov.tools; fi;
+          export DOMAIN=${DOMAIN:-$ENVIRONMENT-$CARDANO_NETWORK.govtool.byron.network}
+          make prepare-config
           make upload-config
+      - name: Destroy Cardano Node, DB sync and Postgres if required
+        if: ${{ inputs.resync_cardano_node_and_db }}
+        run: |
+          if [[ "${{ inputs.environment }}" == "staging" ]]; then export DOMAIN=staging.govtool.byron.network; fi;
+          if [[ "${{ inputs.environment }}" == "beta" ]]; then export DOMAIN=sanchogov.tools; fi;
+          make destroy-cardano-node-and-dbsync;
       - name: Deploy app
         run: |
           make docker-login
@@ -186,6 +197,7 @@ jobs:
       GRAFANA_ADMIN_PASSWORD: ${{ secrets.GRAFANA_ADMIN_PASSWORD }}
       GRAFANA_SLACK_RECIPIENT: ${{ secrets.GRAFANA_SLACK_RECIPIENT }}
       GRAFANA_SLACK_OAUTH_TOKEN: ${{ secrets.GRAFANA_SLACK_OAUTH_TOKEN }}
+      NGINX_BASIC_AUTH: ${{ secrets.NGINX_BASIC_AUTH }}
       SENTRY_DSN_BACKEND: ${{ secrets.SENTRY_DSN_BACKEND }}
       TRAEFIK_LE_EMAIL: "admin+vva@binarapps.com"
     steps:
@@ -207,10 +219,17 @@ jobs:
           ssh-private-key: ${{ secrets.GHA_SSH_PRIVATE_KEY }}
       - name: Prepare and upload app config
         run: |
-          make prepare-config
           if [[ "${{ inputs.environment }}" == "staging" ]]; then export DOMAIN=staging.govtool.byron.network; fi;
           if [[ "${{ inputs.environment }}" == "beta" ]]; then export DOMAIN=sanchogov.tools; fi;
+          export DOMAIN=${DOMAIN:-$ENVIRONMENT-$CARDANO_NETWORK.govtool.byron.network}
+          make prepare-config
           make upload-config
+      - name: Destroy Cardano Node, DB sync and Postgres if required
+        if: ${{ inputs.resync_cardano_node_and_db }}
+        run: |
+          if [[ "${{ inputs.environment }}" == "staging" ]]; then export DOMAIN=staging.govtool.byron.network; fi;
+          if [[ "${{ inputs.environment }}" == "beta" ]]; then export DOMAIN=sanchogov.tools; fi;
+          make destroy-cardano-node-and-dbsync;
       - name: Deploy app
         run: |
           make docker-login

.github/workflows/lighthouse.yml

@@ -41,14 +41,14 @@ jobs:
             lhci collect
 
       - name: Evaluate reports
-        if: github.repository_owner != 'input-output-hk'
+        if: github.repository_owner != 'IntersectMBO'
         run: |
             lhci assert  --preset "lighthouse:recommended"
 
 
       - name: Publish reports
         working-directory: ./src/vva-fe
-        if: github.repository_owner == 'input-output-hk'
+        if: github.repository_owner == 'IntersectMBO'
         run: |
             lhci assert  --preset lighthouse:recommended || echo "LightHouse Assertion error ignored ..."
             lhci upload --githubAppToken="${{ secrets.LHCI_GITHUB_APP_TOKEN }}" --token="${{ secrets.LHCI_SERVER_TOKEN }}" --serverBaseUrl=https://lighthouse.cardanoapi.io --ignoreDuplicateBuildFailure

.github/workflows/test_integration_cypress.yml

@@ -14,7 +14,6 @@ on:
         type: choice
         default: "sanchonet"
         options:
-          - "preprod"
           - "sanchonet"
       deployment:
         required: true

.github/workflows/toggle-maintenance.yml

@@ -7,9 +7,8 @@ on:
       cardano_network:
         required: true
         type: choice
-        default: "preprod"
+        default: "sanchonet"
         options:
-          - "preprod"
           - "sanchonet"
       environment:
         required: true
@@ -30,7 +29,7 @@ on:
 
 env:
   ENVIRONMENT: ${{ inputs.environment || 'dev' }}
-  CARDANO_NETWORK: ${{ inputs.cardano_network || 'preprod' }}
+  CARDANO_NETWORK: ${{ inputs.cardano_network || 'sanchonet' }}
 
 jobs:
   check_environment_exists:

CHANGELOG.md

@@ -8,19 +8,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 As a minor extension, we also keep a semantic version for the `UNRELEASED`
 changes.
 
+## [Unreleased]
+
+### Fixed
+- Fixed vote calculation problems related to NoConfidence DRep [Issue 59](https://github.com/IntersectMBO/govtool/issues/59)
+
 ## [sancho-v1.0.1](https://github.com/IntersectMBO/govtool/releases/tag/sancho-v1.0.1) 2023-12-XX
 
 ### Added
-- 
+-
 
 ### Fixed
-- 
+-
 
 ### Changed
-- 
+- Changed Node version from 8.7.1-pre to 8.7.2 and Db-sync version from sancho-2-3-0 to sancho-3-0-0.
+- (`docs/update-working-conventions`) Addressing [Issue 25](https://github.com/IntersectMBO/govtool/issues/25) changed working conventions documentation to improve intended flows.
 
 ### Removed
-- 
+-
 
 ## [sancho-v1.0.0](https://github.com/IntersectMBO/govtool/releases/tag/sancho-v1.0.0) 2023-12-17
 

CONTRIBUTING.md

@@ -8,32 +8,49 @@ This document contains guidelines to help you get started and how to make sure y
 
 ## Table of Contents
 
-- [Code of Conduct](#code-of-conduct)
-- [Ask for Help](#ask-for-help)
-- [Roles and Responsibilities](#roles-and-responsibilities)
-- [I Want To Contribute](#i-want-to-contribute)
-  - [Reporting Bugs](#reporting-bugs)
-  - [Suggesting Enhancements](#suggesting-enhancements)
-  - [Your First Code Contribution](#your-first-code-contribution)
-- [Working Conventions](#working-conventions)
-  - [Pull Requests](#pull-requests)
-  - [Commit Messages](#commit-messages)
-  - [Merge Commit PRs and Rebase Branches on top of Main](#merge-commit-prs-and-rebase-branches-on-top-of-main)
-  - [Versioning and Changelog](#versioning-and-changelog)
-  - [Style Guides](#style-guides)
+- [Contributing to the `GovTool` project](#contributing-to-the-govtool-project)
+  - [Table of Contents](#table-of-contents)
+  - [Code of Conduct](#code-of-conduct)
+  - [Ask for Help](#ask-for-help)
+  - [Roles and Responsibilities](#roles-and-responsibilities)
+  - [I Want To Contribute](#i-want-to-contribute)
+      - [Before Submitting a Bug Report](#before-submitting-a-bug-report)
+      - [How Do I Submit a Good Bug Report?](#how-do-i-submit-a-good-bug-report)
+      - [Your First Code Contribution](#your-first-code-contribution)
+  - [Working Conventions](#working-conventions)
+    - [Pull Requests](#pull-requests)
+    - [Branch Naming](#branch-naming)
+    - [Commit Messages](#commit-messages)
+      - [Rationale](#rationale)
+    - [Merge Commit PRs and Rebase Branches on top of Main](#merge-commit-prs-and-rebase-branches-on-top-of-main)
+      - [Rationale](#rationale-1)
+    - [Versioning](#versioning)
+    - [Changelog](#changelog)
+    - [Style Guides](#style-guides)
+      - [React](#react)
+      - [CSS in Javascript](#css-in-javascript)
+      - [CSS / SASS](#css--sass)
+      - [Haskell](#haskell)
+  - [Bumping Node, DB-Sync, SanchoNet Versions](#bumping-node-db-sync-sanchonet-versions)
+    - [Steps to upgrade](#steps-to-upgrade)
+  - [Development Processes](#development-processes)
+    - [Developer workflow](#developer-workflow)
+    - [QA Workflow](#qa-workflow)
+    - [PO Workflow](#po-workflow)
+    - [Tech Lead Workflow](#tech-lead-workflow)
 
 ## Code of Conduct
 
-This project and everyone participating in it is governed by the [Code of Conduct](https://github.com/IntersectMBO/govtool/blob/main/CODE_OF_CONDUCT.md).
+This project and everyone participating in it is governed by the [Code of Conduct](./CODE-OF-CONDUCT.md).
 By participating, you are expected to uphold this code.
 
 ## Ask for Help
 
-See [`SUPPORT.md`](SUPPORT.md) should you have any questions or need some help in getting set up.
+See [`SUPPORT.md`](./SUPPORT.md) should you have any questions or need some help in getting set up.
 
 ## Roles and Responsibilities
 
-We maintain a [CODEOWNERS file](https://github.com/IntersectMBO/govtool/CODEOWNERS) which provides information who should review a contributing PR.
+We maintain a [CODEOWNERS file](./CODEOWNERS) which provides information who should review a contributing PR.
 Note that you might need to get approvals from all code owners (even though GitHub doesn't give a way to enforce it).
 
 ## I Want To Contribute
@@ -47,7 +64,7 @@ Please complete the following steps in advance to help us fix any potential bug
 - Make sure that you are using the latest version.
 - Determine if your bug is really a bug and not an error on your side.
   e.g. using incompatible environment components/versions.
-  If you are looking for support, you might want to check [this section](#i-have-a-question)).
+  If you are looking for support, you might want to check [this section](#i-have-a-question).
 - To see if other users have experienced (and potentially already solved) the same issue you are having.
 - Also make sure to search the internet (including Stack Overflow)
   to see if users outside of the GitHub community have discussed the issue.
@@ -99,17 +116,24 @@ To get something merged we usually require:
 - Change is related to an issue, feature (idea) or bug report - ideally discussed beforehand
 - Well-scoped - we prefer multiple PRs, rather than a big one
 
+### Branch Naming
+
+- When creating your branches please create informative names.
+- using prefixes such as `feat/`, `fix/`, `chore/`, `docs/` for branch names are a good start.
+
 ### Commit Messages
 
-Please make informative commit messages! It makes it much easier to work out why things are the way they are when you’re debugging things later.
+Please make informative commit messages! 
+It makes it much easier to work out why things are the way they are when you’re debugging things later.
 
-A commit message is communication, so as usual, put yourself in the position of the reader: what does a reviewer, or someone reading the commit message later need to do their job? Write it down! It is even better to include this information in the code itself, but sometimes it doesn’t belong there (e.g. ticket info).
+A commit message is communication, so as usual, put yourself in the position of the reader: what does a reviewer, or someone reading the commit message later need to do their job?
+Write it down!
+It is even better to include this information in the code itself, but sometimes it doesn’t belong there (e.g. ticket info).
 
-Also, include any relevant meta-information, such as ticket numbers.
-If a commit completely addresses a ticket, you can put that in the headline if you want, but it’s fine to just put it in the body.
+Also, include any relevant meta-information, such as issue numbers.
+If a commit completely addresses a issue, you can put that in the headline if you want, but it’s fine to just put it in the body.
 
 Here are seven rules for great git commit messages:
-
 1. Separate subject from body with a blank line
 2. Limit the subject line to 50 characters (soft limit)
 3. Capitalize the subject line
@@ -147,7 +171,7 @@ Releases that aren't stable will be released as pre-releases and will append a -
 
 ### Changelog
 
-During development
+During development, on every PR;
 - Make sure `CHANGELOG.md` is kept up-to-date with high-level, technical, but user-focused list of changes according to [keepachangelog](https://keepachangelog.com/en/1.0.0/).
 - Bump `UNRELEASED` version in `CHANGELOG.md` according to [semver](https://semver.org/).
 
@@ -168,3 +192,57 @@ Please see [CSS / SASS Style Guide](./docs/style-guides/css-sass/).
 #### Haskell
 
 TODO
+
+## Bumping Node, DB-Sync, SanchoNet Versions
+
+- SanchoNet periodically has to be respun, where all data is erased.
+- This is normally to allow for the nodes to be upgraded to a new version, where the old chain may not be compatible with newer node implementation.
+- So to go along with each respin GovTool's Node needs to upgraded to a newer version and it's local database must be dropped.
+- New versions of DB-Sync are usually released alongside new Node versions, to ensure compatibility.
+- Some new versions of DB-Sync will include revisions to the DB schema, if this is the case then we also need to upgrade the BE interface to work.
+
+### Steps to upgrade
+
+1. Coordinate and align with DB-Sync/Node teams to anticipate SanchoNet respins and version releases. Once network has been respun upgrade.
+- Often a new node version is released a few days ahead of a Sanchonet respin, DB-Sync is normally a couple of days post node release.
+2. Change the versions in the [docker-compose file](./src/docker-compose.sanchonet.yml), here the DB-Sync and Node docker versions can be incremented. Merge this change, following standard working conventions.
+- IF the DB-Sync schema changed, then BE changes will have to be merged also.
+3. Then the upgrade can be deployed using normal workflows, ensure to tick `resync_cardano_node_and_db` option of the workflow. This will wipe the existing Node and Db-Sync's data, to let the upgraded versions fully resync.
+4. Wait for resync, depending on the size SanchoNet resycing will likely take over an hour.
+5. Check successful resync, using the BE you are able to check transaction status. You can use the SanchoNet faucet to send transactions, then check faucet Tx id via GovTool BE. If GovTool sees the Tx then GovTool BE is on the same network as the faucet which is ideal.
+
+
+## Development Processes
+
+### Developer workflow
+
+- Choose ticket/issue to work on from the project, move ticket from `todo` to `in progress`.
+- Create [well named](#branch-naming) branch from `develop` add changes, then make a pull request back to the `develop` branch.
+- If the changes are not ready for review then feel free to create a draft PR, and link this to the ticket/issue.
+- Developers should review each other's pull requests, and should be requested via [CODEOWNERS](./CODEOWNERS).
+- Unit tests are run on each pull request to `develop`.
+- Once tests pass and peer review is done the branch can be merged into `develop` by author and then deployed to the dev environment (manually for now).
+- The ticket status can then be moved ticket to `in QA` making sure that the PR/branch has been added to the ticket/issue as a comment.
+
+### QA Workflow
+
+- Choose ticket from `in QA`.
+- Merge in the ticket's changes from `develop` branch into `test` branch.
+- Deploy to test environment (manually for now).
+- The QA tests the deployed test environment against the ticket.
+- If QA agrees that the code is good, they can make a PR from `test` branch to `staging` branch where end-to-end and performance tests are run.
+- If tests pass, then QA or tech lead can merge and deploy to staging environment (manually for now).
+- Moving ticket to `staging` status this ready for PO check.
+
+### PO Workflow
+
+- Choose ticket from `staging` status.
+- Compare the deployment on staging environment to the contents of the ticket.
+- If the deployment has been satisfied via the staging environment, PO comments on the ticket to be included in next release.
+
+### Tech Lead Workflow
+
+- Bundle the staging status tickets together into a new tag.
+- Merge `staging` branch into the `main` branch.
+- Deploy tagged build to `beta` environment.
+- Move tickets from staging status to done status.

README.md

@@ -8,7 +8,7 @@
 
 <div align="center">
 
-[![Build Status](https://img.shields.io/travis/npm/npm/latest.svg?style=flat-square)](https://travis-ci.org/npm/npm) [![npm](https://img.shields.io/npm/v/npm.svg?style=flat-square)](https://www.npmjs.com/package/npm) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](./LICENSE)
+[![npm](https://img.shields.io/npm/v/npm.svg?style=flat-square)](https://www.npmjs.com/package/npm) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 </div>
 

SUPPORT.md

@@ -1,8 +1,6 @@
 # Ask for help
 
-Should you have any questions or need some help in getting set up, you can use
-these communication channels to reach the GovTool team and get answers in a way
-where others can benefit from it as well:
+Should you have any questions or need some help in getting set up, you can use these communication channels to reach the GovTool team and get answers in a way where others can benefit from it as well:
 
 - Github [Discussions](https://github.com/IntersectMBO/govtool/discussions)