Skip to content
This repository has been archived by the owner on Oct 8, 2023. It is now read-only.

Latest commit

 

History

History
106 lines (71 loc) · 4.12 KB

README.md

File metadata and controls

106 lines (71 loc) · 4.12 KB
Raw

Council Emissions Calculator

Civic Maker's Council Carbon Emissions Calculator project

Pull requests Commit history Contributors

Overview

Category Details
Purpose Provide a source of information that facilitates the decision process for councils to become more sustainable
Custodian Civic Makers
Slack #civic-makers-climatechange
Tech Stack Next JS, Chakra UI, Google Sheets
Design https://www.figma.com/file/Y42AKuHDW46LiLDaTOs6sM/Heroes-carbon-calculator-designs?node-id=978%3A54391&t=jSZfGy4RjwTVhtH4-1
Staging Endpoint http://council-emissions-calculator-spike-flax.vercel.app/
Prod Endpoint https://seechange.codeforaustralia.org/

Table of Contents

Project Goals

  • Provide councils a tool to assess their impact on the environment.
  • Provide councils with inspirations and next steps to have a more sustainable way of workingand engage communities in initiatives that are favorable for the environment.
  • Provide a source of information that facilitates the decision process for councils to become more sustainable.

To learn more about this project, check out our project planning and trello project board.

System Diagram

Council carbon emission calculator system diagram

Getting Started

  1. Clone the repository to your local machine.

  2. Install dependencies using your preferred package manager:

npm install

or

yarn install
  1. Run the development server:
npm run dev

or

yarn dev
  1. Open http://localhost:3000 in your browser to view the carbon emission survey website locally.

Development

We have 2 endpoints: Staging and Production.

Please refer to this doc for instructions on how to fork this repo and contributing your changes.

N.B: Please note well that the default branch for this repo is the staging branch, not the main branch; Any new pull request raised for this repo will have its changes pushed to staging branch by default when the PR is approved and merged.

The staging branch is hosted on our Staging endpoint.

The main branch is hosted on our Production endpoint.

Resourses

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Dependencies

  • Google Sheets as database
  • Google Sheets to process form responses and calculate emissions
  • Chakra for UI framework
  • Highcharts to build charts in report
  • Vercel as hosting platform