hqtan / council-emissions-calculator

An experiment to test the initial design of Civic Maker's 2021 Council Emissions Calculator project.

Council Emissions Calculator

An experiment to test the initial design of Civic Maker's 2021 Council Emissions Calculator project.

Project Goals • Getting Started • Development • Collaboration

Project Goals

• Provide councils a tool to assess their impact on the environment and ...
• Provide councils with inspirations and next steps to have a more sustainable way of working.
• Provide councils with inspirations and next steps to 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.

Getting Started

First, install dependencies using your preferred package manager...

npm install
# or
yarn install

Next, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.

Learn More about Development

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

• Next.js Documentation - learn about Next.js features and API.

• Learn Next.js - an interactive Next.js tutorial.

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

Dependencies used in this project

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

Collaboration: Working In a Forked Repository

How to fetch upstream main/master

There are 2 options :

Option 1 : Using terminal

STEPS

1. Checkout to main branch 2. `git branch` view list to confirm 3. `git remote add upstream (URL- copy the URL from Code for Australia CodeforAustralia/council-emissions-calculator-spike git hub)`

• Upstream is the name for the master git repo it can be reasonable any name.

4. git fetch upstream
5. git merge upstream/main
6. git pull

Option 2 : Using button in your main forked repo

STEPS

(located above the code listing right top)

1. Click on fetch upstream button
2. Select Fetch and merge button
3. git pull at the local main branch

• Resolve any conflicts

4. git status
5. git add . or git add (file/path name)
6. git commit -m “note”

To merge the changes to working branch

STEPS

1. git checkout (branch name)
2. git merge main

Contributors ✨

Thanks goes to these wonderful people:

hqtan 💻 📖	ymloh 💻	Matt Sawkill 💻	Bhagyashree 💻 📖
Kris Lubiniecki 💻	Colette Liu 💻	Matt McKenzie 💻	oonamcmanus 💻
Amutha 💻	Russell Jarvis 💻

This project follows the all-contributors specification. Contributions of any kind welcome!