An awesome README to tell you everything you need to know about this project.
- About the Project
- Built With
- Prerequisites to Getting Started
- Getting Started
- Accessing the Application
- How to Deploy the Application
- Contributing
- Asking for help
- Project Conventions
- Contributors
- Contact
- Acknowledgements
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.
- Docker Desktop
- Clone the project source code.
git clone https://github.com/AVu120/civic-makers-climate-change-visualization.git
- Navigate into the project directory.
cd civic-makers-climate-change-visualization
- Build the client & server docker images, run them as containers and have them talking to each other in 1 command.
docker-compose up
- Wait until both containers are up and running before proceeding.
- Client is running on port 3000.
- Server is running/listening on port 5000.
- When necessary, install only the client dependencies you need (e.g. react-scripts to 'npm run build' and testing libraries).
cd client
npm i react-scripts etc.
- When you need to add new npm packages to an image/container, stop that container first, then run
docker-compose build <service-name>
then run
docker-compose up
to restart all the containers (with the new packages).
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.
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:
- build the react app (using
npm run build
) - 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.
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.
- Fork the Project.
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
). - Commit your Changes (
git commit -m 'Add some AmazingFeature'
). - Push to the Branch (
git push origin feature/AmazingFeature
). - Open a Pull Request (PR).
- After 1-2 approvals, the PR will be merged.
- 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!
- React functional components (with hooks)
- PascalCase for file/folder/component/class names.
- camelCase for function/method names.
- CSS TBD.
- Esther (project manager) - [email protected]