Skip to content

Latest commit

 

History

History
67 lines (59 loc) · 2.79 KB

README.md

File metadata and controls

67 lines (59 loc) · 2.79 KB
Raw

save-my-world

The title of our project is called “Save My World”. The main purpose of this project is to convert climate change evangelists into climate change detractors. Climate change is a serious problem and we will need to harness the collective power of humans to mitigate its disastrous and dangerous effects.

Why did we build Save-My-World

We wanted to tackle the question “How can we convert climate change skeptics into evangelists amidst the vast sea of information, such that there will be more supporters of climate change?”. Having said that, our application helps to educate the public on why there is a need to tackle climate change by providing graphical visuals, state-of-the-art imagery, gamification, and a mapbox to allow our users to observe how Earth is changing.

Technologies used

Main application:

Vue CLI
Javascript
NPM

Styling:

Bootstrap
SCSS

Database:

Firebase

BTL technologies:

GitHub - Version Control
Netlify - Deployment
SCSS Framework
AWS Integration

APIs Used:

AWS API Gateway
Open weather API
World Bank API
Location IQ API
Relief Web API

Project Environment Setup

  1. Ensure that NPM and node.js is installed. https://docs.npmjs.com/downloading-and-installing-node-js-and-npm#using-a-node-installer-to-install-node-js-and-npm
  2. Ensure that git is installed. https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
  3. Choose a folder which you want to store the repo and go into the folder
  4. git clone https://github.com/quinncheong/save-my-world.git to clone the new repo and change directory into the folder
  5. Ensure that you have the .env file and place it in the root directory. WE ARE NOT UPLOADING IT FOR SECURITY'S PURPOSES. Please contact Quinn Cheong

Starting the project

Run "npm install" to download all dependencies

Compiles and hot-reloads for development

1. "npm run serve" on the command line to start the application
2. Open localhost:8080 to access the application. If port 8080 is used, the application might open at port 8081.

Compiles and minifies for production

npm run build

Lints and fixes files

npm run lint

Customize configuration

See Configuration Reference.

Built by

Jie Peng Wong Lee Zi Qi Lau Wei Ting Quinn Cheong

End Notes

  1. The site is not fully customised for Responsiveness on Safari Browsers.
  2. We would like to thanks all library contributors who have helped us doing our short journey of developing the application.
  3. Stay safe and good luck everyone :D