Skip to content

dpgabot/submission-digitalpublicgoods

Repository files navigation

License: Apache 2.0 Contributor Covenant

Digital Public Goods Submission Form

Overview

This webapp is built using Next.js as a React Framework and deployed using Vercel.

The forms are Data Driven Forms, configured through this JSON schema: schema.js.

Design Requirements

  • Support for standard HTML Field Types: Drop downs, Multiple choice, Short answer/long answer
  • Descriptive paragraphs (helperText)
  • Field validation
  • Required fields
  • Questions being hidden and presenting themselves based on previous questions i.e. If you select SDG 4
  • Sections
  • Logic (skip questions/go to question based on response)
  • Autosaving
  • Collect emails
  • Login (authenticate / user management)
  • Progress indicator
  • Save and come back to continue editing
  • Mailchimp integration: automatic sending of emails based on certain form responses
  • Admin Interface:

    • Admin Interface
    • Review forms individually
    • Some data aggregated (summary view)
    • Percentage of docs through forms
    • How many forms were not complete (aborted applications)
  • For Communities of Practice:

    • P1. Keyword search through applications (i.e. to find ones related to health, finance, climate)
    • The ability to export project applications (same as the ability to review forms individually but also to have in a form you can send people)
    • P2 - A review tool for CoP members who can vote yes/no on projects?

Configuration

Set the following environment variables in a .env.local file:

ACCESS_TOKEN={YOUR_GITHUB_TOKEN_HERE}
NEXT_PUBLIC_GITHUB_OWNER=lacabra
NEXT_PUBLIC_GITHUB_REPO=submission-digitalpublicgoods
GITHUB_BRANCH=main
GITHUB_ASSIGNEES="comma-separated list of users"
NEXT_PUBLIC_GOOGLE_SPREADSHEET_SCRIPT_URL={GOOGLE_SPREADSHEET_SCRIPT_URL}
MY_AWS_ACCESS_KEY_ID={YOUR_AWS_ACCESS_KEY_ID}
MY_AWS_SECRET_ACCESS_KEY={YOUR_AWS_SECRET_ACCESS_KEY}

📝 License

This software is licensed under the Apache License 2.0:

   Copyright 2021 UNICEF

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

The two main dependencies (and their respective licenses) this software depends on are:

About

Submission form for Digital Public Goods

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published