Git Product home page Git Product logo

ecowhat's Introduction

Welcome to EcoWhat? - a full stack project for the Bright Network Technology Academy.

Introduction

A full stack application centred around climate activism, EcoWhat? allows you to understand your MPs stance on climate change and have your say about it.

Here is a link to the app presentation: https://view.genial.ly/61bb884656c96a0dce09a67c/presentation-ecowhat

About the project

This project was created as part of the Bright Network Technology Academy bootcamp. It features a React front end and Spring Boot back end connected to a PostgreSQL database. We also use open APIs in the front and back end to collate information on Members of Parliament and their voting history on the environment. Our database stores user information and comments, as well as environmental and geographic data, which our API allows us to use in the front end.

Features

  • Encrypted passwords for secure user login
  • Find your constituency through our postcode search or interactive map that redirects you to the matching constituency page
  • Comments for logged in users, which can be upvoted or downvoted and are censored for inappropriate language
  • Declarative component routing using React Router to create several 'pages'
  • Up-to-date data from the government's MP and votes APIs
  • Tweet or email your MP from their constituency page

How to Set Up and Use

Setup

First, clone or download this repository. The Spring Boot backend requires a local PostgreSQL database. If you do not have Psql set up on your machine, install it! This website provides a great walkthrough, just make sure to keep a note of your Psql username and password: https://www.prisma.io/dataguide/postgresql/setting-up-a-local-postgresql-database

Then, create a local PostgreSQL database called ecowhat. You will need to update the application.properties file in the server side of the repository, changing the username and password to your Psql username and password. This file can be found in the /server/proj/proj/src/main/resources folder. You may also need to connect the Spring application to your local ecowhat database.

After this, you should be able to run the Spring application by running the main method in the ProjApplication.java file, which can found in the /server/proj/proj/src/main/java/com/capston/proj folder. Or, you may be able to run the project as a whole from your IDE. It may take a few seconds for the application to fully start up.

To set up the React portion of the application, navigate to the client/my-app directory and run $ npm install to install all the required dependencies. Then, use $ npm start to start the application, on port 3000 by default. This will automatically open the website or you can go to http://localhost:3000/ to access it.

Use

Sign up by clicking on Sign Up from the navigation bar, and submitting a completed signup form. Once you have successfully created an account, you will be redirected to the Log In page which you can also access from the navbar.

As a logged in user, you can then access all the features of the website. The extra functionality for logged in users includes the ability to leave coments and a Profile page which shows you your details and comment history.

The About page provide information on the background of the project, and the What You Can Do page provides resources for offline actions that individuals can take to help protect the environment.

Most of the content is on the constituency pages, which can be accessed either by selecting a consituency through the map, or submitting a postcode through the search bar. Users can then toggle a list of of climate related votes the MP for that constituency has taken, as well as send them a tweet or email asking them to do more for the environment.

Each constituency has a comments section, where logged in users can post comments and upvote or downvote them.

Team:

  • Helena
  • Chaam
  • Vinh
  • Jonathan
  • Tamara

ecowhat's People

Contributors

czboop avatar djontleman avatar helboi4 avatar tamaraherrington avatar vinhchugg avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.