Skip to content

Commit a7cb526

Browse files
authored
Merge pull request #40 from undp/main
Sync
2 parents ea98193 + a2e2cf0 commit a7cb526

5 files changed

Lines changed: 125 additions & 29 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
* [Run Services on Cloud](#cloud)
88
* [User Onboarding](#user)
99
* [Web Frontend](#frontend)
10+
* [Localization](#localization)
1011
* [API](#api)
1112
* [Status Page](#status)
1213
* [Governance & Support](#support)
@@ -214,6 +215,11 @@ All the CRUD operations can be performed as per the following table,
214215
### Web Frontend
215216
Web frontend implemented using ReactJS framework. Please refer [getting started with react app](./web/README.md) for more information.
216217
218+
<a name="localization"></a>
219+
### Localization
220+
* Languages (Current): English
221+
* Languages (In Progress): French. Spanish
222+
For updating translations or adding new ones, reference https://github.com/undp/carbon-registry/tree/main/web/public/Assets/i18n
217223
218224
<a name="api"></a>
219225
### Application Programming Interface (API)

TOR National Implementation.md

Lines changed: 104 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,129 @@
1-
The following work steps are required for the national implementation of the DPG carbon registry in any country.
1+
# Sample Terms of Reference
2+
The TOR can be further specified if national details are known, e.g. about the NDC management tool.
3+
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.
4+
5+
## 1. Installation
6+
The following work steps are suggested for the national implementation of the DPG carbon registry in any country.
27

38
- Installation of a Carbon Registry from https://github.com/undp/carbon-registry
49

10+
- Technical timeline/roadmap
11+
- Fork the [Carbon Registry](https://github.com/undp/carbon-registry). Send pull requests to `staging` for added features (languages, security patchees, modules, etc.).
12+
513
- Initial Setup of the Carbon Registry, including localization to national requirements:
6-
- translation into relevant national languages *(Link to the .json/yaml files that need translation HERE)*
7-
- adjust sectors to match the sectors specified in the nationally determined contribution *(link to file that specifies sectors HERE)*
8-
- integration with existing NDC management tools (if applicable)
14+
- translation of text into relevant national languages
15+
- adjust colors, logos, maps, etc. to national standard
16+
- design graphics
17+
- purchase domain, hosting, & security certificate
18+
- register & connect supporting services (analytics, forms, etc.)
19+
- adjust sectors to match the sectors specified in the nationally determined contribution
20+
- integration with existing NDC management tools (if applicable) [API]
921
- adjustment of user types to national requirements
1022
- creation of government accounts
11-
*(Deliverable: Fully localized Carbon Registry running on test environment)*
23+
- status page for monitoring uptime, utlizing https://github.com/undp/carbon-registry-status
24+
- *(Deliverable: Fully localized Carbon Registry running on staging (test) environment & productive (live) environment)*
1225

1326
- 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.
1427
*(Deliverable: Test Report)*
1528
- Creation of a nationally appropriate signup proceedure for non-government accounts
1629
- Hand over to official government use
17-
*(Deliverable: Government Acceptance)*
30+
*(Deliverable: Government Acceptance. Source code submission (ideally on `GitHub`) approved.)*
31+
- Testing: Security, Privacy, Accessability. *(Deliverable: 3rd party and/or automated tests.)*
32+
- Ticketing system: For submitting, tracking, & responding to platform requests & bugs.
33+
- Warranty: Supporting long term web hosting and operation (DevOps) of the registry
34+
- Training: manual. video/screen recording walkthrough. guidebook. workshops.
35+
- Awareness: advertising. community outreach.
1836

19-
- Long term hosting and DevOps of the registry
37+
## 2. Scope of Work
38+
- Design
39+
- User Interface (UI) Design
40+
- Real-Time Reviewing & Commenting Mechanism
41+
- Quality Assurance (QA) & User Testing
42+
- Internal Test with SME for the MVP version
43+
- Software Development
44+
- Cloud-Based Containerized Web-Application for Desktop users
45+
- DevOps, including Hosting Page
46+
- Analytics
47+
- Accessibility
48+
- Handover & Training
49+
- Video/screen recording walkthrough
50+
- Source code to be submitted to the official UNDP GitHub repository with full source documentation, use cases, and functional requirements.
51+
- Support & Maintenance
52+
- x months of maintenance
53+
- y days per month are required
54+
- Service Level Agreement (SLA):
2055

21-
Sample Terms of Reference
22-
The TOR can be further specified if national details are known, e.g. about the NDC management tool.
23-
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.
2456

25-
1. Scope of Work
57+
|Critical Level| Response Time| Resolution Time|
58+
|---|---|---|
59+
|Critical (System down)| <10 mins| <2 hours|
60+
High| <30 mins <4 hours|
61+
Medium| <4 hours| <48 hours|
62+
Low| < 48 hours| <3 days|
63+
Planning| < 48 hours| < 5 days|
2664

27-
3. Deliverables
65+
66+
67+
## 3. Deliverables
2868
- Deliverable 1:
2969
- Deliverable 2:
3070
- Deliverable 3:
3171
- Deliverable 4: Maintenance of the registry (This is optional, however highly recommended to ensure upgrade and security checks)
3272

73+
### Deliverable Requirements
74+
75+
- AGPL-3.0 software license
76+
- UNDP Data Principles Adherence [https://data.undp.org/data-principles/](https://data.undp.org/data-principles/)
77+
- Contributor Covenant Code of Conduct Adherence
78+
- Reporting
79+
- GDPR-compliant Analytics
80+
- Notifications
81+
- Email notifications and reports
82+
- Infrastructure
83+
- Cloud-based
84+
- Regular data export and/or backups
85+
- Staging & Production environments
86+
- DevOps
87+
- Status page
88+
- Domain & security certificate management
89+
- Containerized
90+
- Accessibility Compliance (W3C)
91+
- Audit: Internal
92+
- Multi-Language Support
93+
- Ticketing system
94+
- Service level agreement (SLA)
95+
- Platform(s): Desktop Web
96+
- Integrations
97+
- UNDP ITMO Platform
98+
- Privacy & Security
99+
- Security audit: External
100+
- Privacy audit: Internal documentation of adherence to UNDP Data Principles
101+
33102
Other items to consider:
34103
- Hosting / clound server:
35104
- 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.
36-
- Server specs-
105+
- Server specifications: TBD
37106

38-
4. Required persons / skills
39-
- Developer 1:
40-
- Developer 2:
107+
## 4. Required persons / skills
108+
- Developers (x2):
109+
- At least 5 years of previous working experience in Web development with front-end and back-end is required;
110+
- Previous experience with human-centered design and agile software development and methodology is preferred;
111+
- Demonstrated experience in JavaScript, Html5, CSS3, (Angular; ReactJS; Vue.JS…) for front end development is strongly preferred
112+
- Proven previous experience in API programming (NodeJS /PHP…) is an advantage
113+
- Demonstrated experience in Database Development: e.g. MSSQL, MariaDB, MySQL, Oracle, PostgreSQL is an asset
114+
- Demonstrated proficiency in DevOps: Azure DevOps, Docker, Git, Deployment pipeline, test automation is preferred
41115
- Project manager:
42-
- Carbon or stakeholder engagement expert (optional)
116+
- Minimum of 5 years of product management experience, with at least 2 years working in a startup environment
117+
- Have shipped at least 1 digital product with proven impact.
118+
- Been working with quantitative and qualitative Data
119+
- Digitally competent and have a high drive for understanding and meeting users needs
120+
- Experience in start-ups, with Agile methodology as well as UX are a plus but not a requirement
121+
- Strong project manager and have experience in leading cross-functional project teams
122+
- Ability to solve complicated problems and understanding end-customer needs are part of your core strengths
123+
124+
- Carbon or stakeholder engagement expert - local and/or (optional)
125+
- At least 5 years experience in climate policies, carbon markets and other green financing mechanisms are required
126+
- Knowledge of digital technology or digitalization is strongly desired
127+
- Direct experience related to mitigation outcome agreements at the national or international level is strongly desired
128+
- Direct experience in developing or overseeing digital systems related to climate or carbon reporting, accounting, measurement, verification is strongly desired
129+
- Experience in business development and entrepreneurship is an asset

lambda/services/yarn.lock

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4851,9 +4851,9 @@ cookie@0.5.0:
48514851
integrity sha512-YZ3GUyn/o8gfKJlnlX7g7xq4gyO6OSuhGPKaaGssGB2qgDUS0gPgtTvoyZLTt9Ab6dC4hfc9dV5arkvc/OCmrw==
48524852

48534853
cookiejar@^2.1.3:
4854-
version "2.1.3"
4855-
resolved "https://registry.yarnpkg.com/cookiejar/-/cookiejar-2.1.3.tgz#fc7a6216e408e74414b90230050842dacda75acc"
4856-
integrity sha512-JxbCBUdrfr6AQjOXrxoTvAMJO4HBTUIlBzslcJPAz+/KT8yk53fXun51u+RenNYvad/+Vc2DIz5o9UxlCDymFQ==
4854+
version "2.1.4"
4855+
resolved "https://registry.yarnpkg.com/cookiejar/-/cookiejar-2.1.4.tgz#ee669c1fea2cf42dc31585469d193fef0d65771b"
4856+
integrity sha512-LDx6oHrK+PhzLKJU9j5S7/Y3jM/mUHvD/DeI1WQmJn652iPC5Y4TBzC9l+5OMOXlyTTA+SmVUPm0HQUwpD5Jqw==
48574857

48584858
core-js-compat@^3.25.1:
48594859
version "3.26.1"
@@ -6425,9 +6425,9 @@ htmlescape@^1.1.0:
64256425
integrity sha512-eVcrzgbR4tim7c7soKQKtxa/kQM4TzjnlU83rcZ9bHU6t31ehfV7SktN6McWgwPWg+JYMA/O3qpGxBvFq1z2Jg==
64266426

64276427
http-cache-semantics@^4.0.0:
6428-
version "4.1.0"
6429-
resolved "https://registry.yarnpkg.com/http-cache-semantics/-/http-cache-semantics-4.1.0.tgz#49e91c5cbf36c9b94bcfcd71c23d5249ec74e390"
6430-
integrity sha512-carPklcUh7ROWRK7Cv27RPtdhYhUsela/ue5/jKzjegVvXDqM2ILE9Q2BGn9JZJh1g87cp56su/FgQSzcWS8cQ==
6428+
version "4.1.1"
6429+
resolved "https://registry.yarnpkg.com/http-cache-semantics/-/http-cache-semantics-4.1.1.tgz#abe02fcb2985460bf0323be664436ec3476a6d5a"
6430+
integrity sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ==
64316431

64326432
http-errors@2.0.0:
64336433
version "2.0.0"
@@ -9689,9 +9689,9 @@ simple-concat@^1.0.0:
96899689
integrity sha512-cSFtAPtRhljv69IK0hTVZQ+OfE9nePi/rtJmw5UjHeVyVroEqJXP1sFztKUy1qU+xvz3u/sfYJLa947b7nAN2Q==
96909690

96919691
simple-git@^3.7.0:
9692-
version "3.15.1"
9693-
resolved "https://registry.yarnpkg.com/simple-git/-/simple-git-3.15.1.tgz#57f595682cb0c2475d5056da078a05c8715a25ef"
9694-
integrity sha512-73MVa5984t/JP4JcQt0oZlKGr42ROYWC3BcUZfuHtT3IHKPspIvL0cZBnvPXF7LL3S/qVeVHVdYYmJ3LOTw4Rg==
9692+
version "3.16.0"
9693+
resolved "https://registry.yarnpkg.com/simple-git/-/simple-git-3.16.0.tgz#421773e24680f5716999cc4a1d60127b4b6a9dec"
9694+
integrity sha512-zuWYsOLEhbJRWVxpjdiXl6eyAyGo/KzVW+KFhhw9MqEEJttcq+32jTWSGyxTdf9e/YCohxRE+9xpWFj9FdiJNw==
96959695
dependencies:
96969696
"@kwsites/file-exists" "^1.1.1"
96979697
"@kwsites/promise-deferred" "^1.1.1"

modules/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
### Modules
2+
# Free open-source solutions for environmental monitoring integrated with the Carbon Registry
3+
Instructions on how to integrate and list of projects who have built module integrations coming soon.

web/yarn.lock

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5953,9 +5953,9 @@ htmlparser2@^6.1.0:
59535953
entities "^2.0.0"
59545954

59555955
http-cache-semantics@^4.0.0, http-cache-semantics@^4.1.0:
5956-
version "4.1.0"
5957-
resolved "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.1.0.tgz"
5958-
integrity sha512-carPklcUh7ROWRK7Cv27RPtdhYhUsela/ue5/jKzjegVvXDqM2ILE9Q2BGn9JZJh1g87cp56su/FgQSzcWS8cQ==
5956+
version "4.1.1"
5957+
resolved "https://registry.yarnpkg.com/http-cache-semantics/-/http-cache-semantics-4.1.1.tgz#abe02fcb2985460bf0323be664436ec3476a6d5a"
5958+
integrity sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ==
59595959

59605960
http-deceiver@^1.2.7:
59615961
version "1.2.7"

0 commit comments

Comments
 (0)