Giter VIP home page Giter VIP logo

magicswissweed's Introduction

MagicSwissWeed

An overview of current surfing conditions in Switzerland. Check it out.

Description

I started this project because I am a passionate surfer in a landlocked country (without any neat forecasting app yet) and because I occasionally like to work with code.

The idea is simple enough: Surfing in Switzerland means surfing in rivers, but this only works if there's enough water in them. Luckily, the Swiss government runs frequent measurements of the water flow and a really cool dude created an API to fetch them. So, all I have to do is get a few values of interest from this API. Simple, right?

Well, not if you've never worked with APIs and have very limited knowledge of websites. Nevertheless, this makes for a perfect learning project: a modest target and a long-held desire to finally work with JavaScript. Now, let's hope the tool will be of value to Swiss surfers too.

Development

Installation

This project is based on Create React App, so you'll need Node.js. First, download the node version manager nvm:

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

Restart your terminal or start a new session to load the changes. Then, install the latest node version:

nvm install node # "node" is an alias for the latest version

Running the code

In the project directory, you can run:

npm install

to download all required packages. Then,

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

Debugging

For Visual Studio Code, install JavaScript Debugger and use the Chrome: launch template to debug with breakpoints.

npm test

Launches the test runner in the interactive watch mode.
Test scripts have to be tailored to your project.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

npm run deploy

Builds the project, pushes the build folder to an existing branch called gh-pages, and publishes the website.

See the section about deployment for more information.

Help

For issues with React: https://react.dev/community.

Roadmap

V1

  • Simple text-only display of current flow values in selected Swiss surfing spots
  • Color-coded numbers to indicate water temperatures

V2

  • Map view of spots in Switzerland
  • Conditions visible when hovering over marked locations

License

This project is licensed under the GNU GPLv3 License - see the LICENSE.md file for details

Acknowledgments

magicswissweed's People

Contributors

nkueng avatar

Watchers

 avatar Gian-Marco Hutter avatar

Forkers

aaronoderstudi

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.