diff --git a/README.md b/README.md index a2873f889..9101eea4a 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ * [Run Services on Cloud](#cloud) * [User Onboarding](#user) * [Web Frontend](#frontend) +* [Localization](#localization) * [API](#api) * [Status Page](#status) * [Governance & Support](#support) @@ -214,6 +215,11 @@ All the CRUD operations can be performed as per the following table, ### Web Frontend Web frontend implemented using ReactJS framework. Please refer [getting started with react app](./web/README.md) for more information. + +### Localization +* Languages (Current): English +* Languages (In Progress): French. Spanish +For updating translations or adding new ones, reference https://github.com/undp/carbon-registry/tree/main/web/public/Assets/i18n ### Application Programming Interface (API) diff --git a/TOR National Implementation.md b/TOR National Implementation.md index d47af241e..829236b8f 100644 --- a/TOR National Implementation.md +++ b/TOR National Implementation.md @@ -1,42 +1,129 @@ -The following work steps are required for the national implementation of the DPG carbon registry in any country. +# Sample Terms of Reference +The TOR can be further specified if national details are known, e.g. about the NDC management tool. +These worksteps can also be intergrated with larger TORs, especially TORs covering wider NDC management / transparency. Below are sample phrases that may be used. Generally a vendor (firm) or a group of individual consultant are encouraged, as the required skills vary. + +## 1. Installation +The following work steps are suggested for the national implementation of the DPG carbon registry in any country. - Installation of a Carbon Registry from https://github.com/undp/carbon-registry +- Technical timeline/roadmap +- Fork the [Carbon Registry](https://github.com/undp/carbon-registry). Send pull requests to `staging` for added features (languages, security patchees, modules, etc.). + - Initial Setup of the Carbon Registry, including localization to national requirements: - - translation into relevant national languages *(Link to the .json/yaml files that need translation HERE)* - - adjust sectors to match the sectors specified in the nationally determined contribution *(link to file that specifies sectors HERE)* - - integration with existing NDC management tools (if applicable) + - translation of text into relevant national languages + - adjust colors, logos, maps, etc. to national standard + - design graphics + - purchase domain, hosting, & security certificate + - register & connect supporting services (analytics, forms, etc.) + - adjust sectors to match the sectors specified in the nationally determined contribution + - integration with existing NDC management tools (if applicable) [API] - adjustment of user types to national requirements - creation of government accounts -*(Deliverable: Fully localized Carbon Registry running on test environment)* + - status page for monitoring uptime, utlizing https://github.com/undp/carbon-registry-status + - *(Deliverable: Fully localized Carbon Registry running on staging (test) environment & productive (live) environment)* - Successful end-to-end test of the registry. This test needs to cover the full lifecycle of one dummy project including at least project creation, authorization, implementation, MRV, issuance and transfer. *(Deliverable: Test Report)* - Creation of a nationally appropriate signup proceedure for non-government accounts - Hand over to official government use -*(Deliverable: Government Acceptance)* +*(Deliverable: Government Acceptance. Source code submission (ideally on `GitHub`) approved.)* +- Testing: Security, Privacy, Accessability. *(Deliverable: 3rd party and/or automated tests.)* +- Ticketing system: For submitting, tracking, & responding to platform requests & bugs. +- Warranty: Supporting long term web hosting and operation (DevOps) of the registry +- Training: manual. video/screen recording walkthrough. guidebook. workshops. +- Awareness: advertising. community outreach. -- Long term hosting and DevOps of the registry +## 2. Scope of Work +- Design + - User Interface (UI) Design + - Real-Time Reviewing & Commenting Mechanism +- Quality Assurance (QA) & User Testing + - Internal Test with SME for the MVP version +- Software Development + - Cloud-Based Containerized Web-Application for Desktop users + - DevOps, including Hosting Page + - Analytics + - Accessibility +- Handover & Training + - Video/screen recording walkthrough + - Source code to be submitted to the official UNDP GitHub repository with full source documentation, use cases, and functional requirements. +- Support & Maintenance + - x months of maintenance + - y days per month are required + - Service Level Agreement (SLA): -Sample Terms of Reference -The TOR can be further specified if national details are known, e.g. about the NDC management tool. -These worksteps can also be intergrated with larger TORs, especially TORs covering wider NDC management / transparency. Below are sample phrases that may be used. Generally a vendor (firm) or a group of individual consultant are encouraged, as the required skills vary. -1. Scope of Work +|Critical Level| Response Time| Resolution Time| +|---|---|---| +|Critical (System down)| <10 mins| <2 hours| +High| <30 mins <4 hours| +Medium| <4 hours| <48 hours| +Low| < 48 hours| <3 days| +Planning| < 48 hours| < 5 days| -3. Deliverables + + +## 3. Deliverables - Deliverable 1: - Deliverable 2: - Deliverable 3: - Deliverable 4: Maintenance of the registry (This is optional, however highly recommended to ensure upgrade and security checks) +### Deliverable Requirements + +- AGPL-3.0 software license +- UNDP Data Principles Adherence [https://data.undp.org/data-principles/](https://data.undp.org/data-principles/) +- Contributor Covenant Code of Conduct Adherence +- Reporting +- GDPR-compliant Analytics +- Notifications + - Email notifications and reports +- Infrastructure + - Cloud-based + - Regular data export and/or backups + - Staging & Production environments + - DevOps + - Status page + - Domain & security certificate management + - Containerized +- Accessibility Compliance (W3C) +- Audit: Internal +- Multi-Language Support +- Ticketing system +- Service level agreement (SLA) +- Platform(s): Desktop Web +- Integrations + - UNDP ITMO Platform +- Privacy & Security + - Security audit: External + - Privacy audit: Internal documentation of adherence to UNDP Data Principles + Other items to consider: - Hosting / clound server: - The ToR is based on the assumption that he government entity has or will prepare a hosting environment in a cloud server. If the government does not have a server space, consider if the vendor will need to host the registry. If so, consider if the vendor can be contracted for a long term. -- Server specs- +- Server specifications: TBD -4. Required persons / skills - - Developer 1: - - Developer 2: +## 4. Required persons / skills + - Developers (x2): + - At least 5 years of previous working experience in Web development with front-end and back-end is required; + - Previous experience with human-centered design and agile software development and methodology is preferred; + - Demonstrated experience in JavaScript, Html5, CSS3, (Angular; ReactJS; Vue.JS…) for front end development is strongly preferred + - Proven previous experience in API programming (NodeJS /PHP…) is an advantage + - Demonstrated experience in Database Development: e.g. MSSQL, MariaDB, MySQL, Oracle, PostgreSQL is an asset + - Demonstrated proficiency in DevOps: Azure DevOps, Docker, Git, Deployment pipeline, test automation is preferred - Project manager: - - Carbon or stakeholder engagement expert (optional) + - Minimum of 5 years of product management experience, with at least 2 years working in a startup environment + - Have shipped at least 1 digital product with proven impact. + - Been working with quantitative and qualitative Data + - Digitally competent and have a high drive for understanding and meeting users needs + - Experience in start-ups, with Agile methodology as well as UX are a plus but not a requirement + - Strong project manager and have experience in leading cross-functional project teams + - Ability to solve complicated problems and understanding end-customer needs are part of your core strengths + + - Carbon or stakeholder engagement expert - local and/or (optional) + - At least 5 years experience in climate policies, carbon markets and other green financing mechanisms are required + - Knowledge of digital technology or digitalization is strongly desired + - Direct experience related to mitigation outcome agreements at the national or international level is strongly desired + - Direct experience in developing or overseeing digital systems related to climate or carbon reporting, accounting, measurement, verification is strongly desired + - Experience in business development and entrepreneurship is an asset diff --git a/lambda/services/yarn.lock b/lambda/services/yarn.lock index eced90049..089006d2c 100644 --- a/lambda/services/yarn.lock +++ b/lambda/services/yarn.lock @@ -4851,9 +4851,9 @@ cookie@0.5.0: integrity sha512-YZ3GUyn/o8gfKJlnlX7g7xq4gyO6OSuhGPKaaGssGB2qgDUS0gPgtTvoyZLTt9Ab6dC4hfc9dV5arkvc/OCmrw== cookiejar@^2.1.3: - version "2.1.3" - resolved "https://registry.yarnpkg.com/cookiejar/-/cookiejar-2.1.3.tgz#fc7a6216e408e74414b90230050842dacda75acc" - integrity sha512-JxbCBUdrfr6AQjOXrxoTvAMJO4HBTUIlBzslcJPAz+/KT8yk53fXun51u+RenNYvad/+Vc2DIz5o9UxlCDymFQ== + version "2.1.4" + resolved "https://registry.yarnpkg.com/cookiejar/-/cookiejar-2.1.4.tgz#ee669c1fea2cf42dc31585469d193fef0d65771b" + integrity sha512-LDx6oHrK+PhzLKJU9j5S7/Y3jM/mUHvD/DeI1WQmJn652iPC5Y4TBzC9l+5OMOXlyTTA+SmVUPm0HQUwpD5Jqw== core-js-compat@^3.25.1: version "3.26.1" @@ -6425,9 +6425,9 @@ htmlescape@^1.1.0: integrity sha512-eVcrzgbR4tim7c7soKQKtxa/kQM4TzjnlU83rcZ9bHU6t31ehfV7SktN6McWgwPWg+JYMA/O3qpGxBvFq1z2Jg== http-cache-semantics@^4.0.0: - version "4.1.0" - resolved "https://registry.yarnpkg.com/http-cache-semantics/-/http-cache-semantics-4.1.0.tgz#49e91c5cbf36c9b94bcfcd71c23d5249ec74e390" - integrity sha512-carPklcUh7ROWRK7Cv27RPtdhYhUsela/ue5/jKzjegVvXDqM2ILE9Q2BGn9JZJh1g87cp56su/FgQSzcWS8cQ== + version "4.1.1" + resolved "https://registry.yarnpkg.com/http-cache-semantics/-/http-cache-semantics-4.1.1.tgz#abe02fcb2985460bf0323be664436ec3476a6d5a" + integrity sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ== http-errors@2.0.0: version "2.0.0" @@ -9689,9 +9689,9 @@ simple-concat@^1.0.0: integrity sha512-cSFtAPtRhljv69IK0hTVZQ+OfE9nePi/rtJmw5UjHeVyVroEqJXP1sFztKUy1qU+xvz3u/sfYJLa947b7nAN2Q== simple-git@^3.7.0: - version "3.15.1" - resolved "https://registry.yarnpkg.com/simple-git/-/simple-git-3.15.1.tgz#57f595682cb0c2475d5056da078a05c8715a25ef" - integrity sha512-73MVa5984t/JP4JcQt0oZlKGr42ROYWC3BcUZfuHtT3IHKPspIvL0cZBnvPXF7LL3S/qVeVHVdYYmJ3LOTw4Rg== + version "3.16.0" + resolved "https://registry.yarnpkg.com/simple-git/-/simple-git-3.16.0.tgz#421773e24680f5716999cc4a1d60127b4b6a9dec" + integrity sha512-zuWYsOLEhbJRWVxpjdiXl6eyAyGo/KzVW+KFhhw9MqEEJttcq+32jTWSGyxTdf9e/YCohxRE+9xpWFj9FdiJNw== dependencies: "@kwsites/file-exists" "^1.1.1" "@kwsites/promise-deferred" "^1.1.1" diff --git a/modules/README.md b/modules/README.md new file mode 100644 index 000000000..7e984ee67 --- /dev/null +++ b/modules/README.md @@ -0,0 +1,3 @@ +### Modules +# Free open-source solutions for environmental monitoring integrated with the Carbon Registry +Instructions on how to integrate and list of projects who have built module integrations coming soon. diff --git a/web/yarn.lock b/web/yarn.lock index b1ba17455..2309eb95b 100644 --- a/web/yarn.lock +++ b/web/yarn.lock @@ -5953,9 +5953,9 @@ htmlparser2@^6.1.0: entities "^2.0.0" http-cache-semantics@^4.0.0, http-cache-semantics@^4.1.0: - version "4.1.0" - resolved "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.1.0.tgz" - integrity sha512-carPklcUh7ROWRK7Cv27RPtdhYhUsela/ue5/jKzjegVvXDqM2ILE9Q2BGn9JZJh1g87cp56su/FgQSzcWS8cQ== + version "4.1.1" + resolved "https://registry.yarnpkg.com/http-cache-semantics/-/http-cache-semantics-4.1.1.tgz#abe02fcb2985460bf0323be664436ec3476a6d5a" + integrity sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ== http-deceiver@^1.2.7: version "1.2.7"