Giter VIP home page Giter VIP logo

toronto-beach-app's Introduction

This is Deprecated!!!!

Hi! We've move the project to a monorepo over /beach

Toronto Beach App

 

The easiest way to view The City of Toronto's Open Data beach data.

 

Getting Started

You'll need an API key from https://www.weatherapi.com/ to access the latest weather info.

Installation

 

Super easy, first run this:

yarn dev

Then to run:

yarn dev

That's it!

Now start using it with the functions and documentation below.

 

Contributing

Please contribute! Create and issue, Pull Requests and we're very excited to have this project open source for the first time

 

Awesome!

If you are interested in learning more, or about contributing, check out the repository at:

https://github.com/mikaalnaik/TorontoBeach

 

toronto-beach-app's People

Contributors

dependabot[bot] avatar mikaalnaik avatar slowmanchan avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

anneloes94

toronto-beach-app's Issues

update README

Readme

The Readme will at least have to include the following:

About

Small section saying what the Toronto Beach App is about

Contributing

What steps can someone take to contribute to this repo? This includes instructions on forking and cloning, referencing to issue labels, how to write commits, etc.

Versions

What minimum versions of npm, Node.js, etc are required?

...?

Create Loading State

Is your feature request related to a problem? Please describe.
While data from the Open Data Toronto API loads, we should display a piece of UI that represents a loading state

Describe the solution you'd like
All of the beach cards are present while the data loads, and the Ecoli number is a loading spinner instead of its numbers

Describe alternatives you've considered
A simple loader at the top level of the application so the beach list wouldn't render initial, but this results in a lower page speed score and suboptimal user experience.

Create individual pages for beaches

Is your feature request related to a problem? Please describe.
Ability to click into a beach card that would redirect you to a specific beach page ie: torontobeach.app/beaches/mariecurtis
or
torontobeach.app/beaches/1

Depending on complexity and benefits between the two different approaches.

A user could explore historical data, find out the amenities, and a place for a future map integration

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Improve UI of beach cards

Is your feature request related to a problem? Please describe.
They sort of look clunky and the information isn't in a super logical order

Describe the solution you'd like
A refined beach card that renders the available, relevant information that's accessible and pleasurable to you.

Describe alternatives you've considered
Keeping it the same. Maybe you love it? Comment below.

Create data with Closed vs Open beaches

Is your feature request related to a problem? Please describe.
When the City of Toronto reopens the 6 beaches on June 22nd, we need a way to 'flag' the closed beaches and display a string like 'this beach isn't open yet'.

ie:

beachStatus.js

export const beachStatus = [
  { beachID: 1, status: open }, 
  { beachID: 2, status: closed }, 
  ...etc
]

Describe the solution you'd like
An additional constant file that is easily maintained and modified once more beaches open up that can be imported to compare against when the API returns all of the beach results.

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.