Civic Makers Climate-Change Visualization

An awesome README to tell you everything you need to know about this project.

Table of Contents

• About the Project
• Built With
• Getting Started
• Accessing the Application
• How to Deploy the Application
• Contributing
• Asking for help
• Project Conventions
• Contributors
• Contact
• Acknowledgements

About The Project

This is a website that will inform visitors about the following:

• Why act on climate change now?
• What you can do about it?
• Why you should get all your friends and family to help too.
• Timeline of significant climate-change related events (including related Australian Parliament Motions/Bills/Divisions).
• Which Members of Parliament (MP) voted for/against motions/bills/divisions.
• MP statistics of their previous voting record and a measure of how accountable they are of keeping their promises.
• Contact forms to MPs to influence their future decisions.
• How to share the above information with others.

Built With

• React
• Node
• Express
• If database is required: MongoDB

Getting Started

Follow the instructions below to set up your local development environment.

The instructions will guide you to deploy two services locally:

• a 'client' service that serves up the react app
• a test api service (that the react app uses)

For more indepth instructions please see this link

0. Open a command line interface (Terminal on mac or equivalent on windows)

   • Tip: For a linux/mac experience on Windows, you can download https://cmder.net/.

1. If you are a MAC user, please install Xcode using the following command

xcode-select --install 

2. Install nvm, a version manager for node.js (for more information see: https://github.com/nvm-sh/nvm)

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.37.0/install.sh | bash

export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm

nvm --version

3. Clone the project source code.

git clone https://github.com/CodeforAustralia/civic-makers-climate-change-visualization.git

4. Navigate into the project directory.

cd civic-makers-climate-change-visualization

5. Install node using nvm:

nvm install
nvm use

6. Double check you are using the right version of node by typing the following command. the version number should match the version number mentioned in .nvmrc file:

$ cat .nvmrc 
14.15.1

$ node --version
v14.15.1

7. To start up the client service, navigate to client/ folder and run npm install

cd client
npm install

run npm start (while in clients folder)

npm start

8. To start up the test api service, open up another terminal, then navigate to the server/ folder and install express and nodemon:

# go to the project directory
cd civic-makers-climate-change-visualization
nvm use
cd server
npm install

run npm start (while in server/ folder):

npm start

9. Go to http://localhost:3000/ . You should see a short welcome message if the app is running.

Accessing the Application

The application is currently hosted on Github Pages.

On your local development instance, enter http://localhost:3000 into any web-browser to view the app.

How to deploy the application

The application is currently hosted on Github Pages.

To deploy the app to Github Pages, run the following commands:

cd client/
npm install  ## [optional] only install dependencies if you haven't done so earlier!
npm run deploy

The command will perform the following actions:

1. build the react app (using npm run build)
2. push the build artifacts to the gh-pages branch

This repo has been set up to serve the content in gh-pages branch on Github Pages

The gh-pages tool was used to ease the deployment of this app.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project.
2. Create your Feature Branch (git checkout -b feature/AmazingFeature).
3. Commit your Changes (git commit -m 'Add some AmazingFeature').
4. Push to the Branch (git push origin feature/AmazingFeature).
5. Open a Pull Request (PR).
6. After 1-2 approvals, the PR will be merged.

Asking for Help

• Please ask on our slack channel #civic-makers-climatechange-dev if you:
  • have any questions regarding any of the tasks in our Trello board
  • have any questions relating to the development of the climate change app
  • need help with a task you are working on from the Trello board
  • have any other questions/proposals you'd like to put to the dev team
• please be patient with our response, as most of us are only working on this in our spare time
• If you like to find out more about what everyone is working on, please come to our weekly Wednesday evening catchups to meet the team! Please ask on #civic-makers-climatechange slack channel to get an invite.
• Some of the dev folk will usually hang around after the catchup to discuss on outstanding issues and do some remote pair/mob programming. But if the timing doesn't work for you, don't fret, please ask on #civic-makers-climatechange-dev to arrange a more suitable time to pair!

Project Conventions

• React functional components (with hooks)
• PascalCase for file/folder/component/class names.
• camelCase for function/method names.
• CSS TBD.

Contributors

• hqtan
• k7n4n5t3w4rt
• izzypeskett
• mcyph
• VasaviGannena
• Amutha37
• rjkr007
• mishfish123
• mansisheth13
• annemariejayatilake
• AVu120

Contact

Emails

• Esther (project manager) - [email protected]

Acknowledgements

• Code for Australia