GithubHelp home page GithubHelp logo

djtpj / atmosweather Goto Github PK

View Code? Open in Web Editor NEW

This project forked from atticuscornett/atmosweather

1.0 0.0 0.0 729.32 MB

Atmos Weather is a lightweight weather app for receiving alerts and forecasts.

Home Page: https://atticuscornett.github.io/AtmosWeather/

License: GNU General Public License v3.0

JavaScript 42.83% Java 38.74% CSS 4.50% HTML 13.30% Batchfile 0.63%

atmosweather's Introduction

Atmos Weather

The cross-platform lightweight app for weather forecasts and alerts.

Available for Windows, MacOS, Linux, and Android at the Atmos Weather Website

GitHub license GitHub all releases GitHub release (latest by date) GitHub last commit GitHub deployments

GitHub Actions

Build for Linux Build for MacOS

Table of Contents

Features

Installation

Project Goals

Major Issues

Documentation

Development

Features

Mobile and Desktop Platforms

Atmos Weather is available on both Windows and Android. Unlike most weather apps, Atmos also provides weather alerts to users on desktop.

Total Control

Atmos Weather gives you complete control over weather alerts. Choose multiple locations to recieve alerts from. Choose alert priority on both an alert type and a location basis.

More Information

Atmos Weather gives you more information about weather warnings. Instead of a text-based warning, Atmos generates a map of warning polygons. It also includes any instructions and details provided by the National Weather Service API.

Reliable Data

Atmos Weather uses the official National Weather Service API to provide the most accurate and up to date warnings possible.

Installation

Stable Version

Website

The easiest way to install Atmos Weather is by using the website: Atmos Weather Website.

Download the version for your platform and run the installer.

GitHub Releases

You can download stable versions from the releases on GitHub.

Beta Versions (Unstable, Power Users)

GitHub Releases

Some beta version builds will be added to GitHub releases.

Latest Builds (Unstable, Not Recommended)

You can download the latest builds for individual platforms from the appropriate build locations for Cordova in the platforms folder or the dist folder inside of the electron folder for ElectronJS builds. These builds (especially Android builds, which may be partial builds) may be broken.

Latest Code (Unstable, Not Recommended)

By downloading the repository files, you can build the latest code on your machine using Cordova.

Project Goals

Minimum Bloat

Most weather apps have too much bloat, largely in the form of overwelming ads. Atmos Weather aims to be as lightweight as possible, providing function without a big footprint.

Timely Alerts

Weather alerts should be given in a timely manner. Ideally, alerts should be given within one minute of being published to the NWS API.

Functionality

Atmos Weather should provide all of the basic functions needed by users, as well as improve in areas that most weather apps and emergency alerts fall short, such as lack of information and customizability for weather alerts.

Privacy and Security

Atmos Weather should not collect any user data beyond what is strictly necessary to provide functionality.

Major Known Issues

Battery Warning On Certain Samsung Models

Samsung marks Atmos Weather as a high battery user, because it wakes up the phone often to check for weather alerts. This can mean automatic throttling of weather checks, leading to late alerts. Despite this warning, Atmos Weather has not been observed to use more than 1-2% a day on these models. At the moment, the only solution is to allow background battery usage and disable battery optimizing for the app. This solves the negative performance impacts, but does not get rid of the warning.

Notifications Don't Work On Some Linux Distros

Some Linux distros lack the components to support electron notifications. There is no current workaround for this issue known to me.

Text To Speech Doesn't Work On Some Linux Distros

Some Linux distros lack the components to support text to speech. This can be solved by the user manually installing text to speech components.

Documentation

Most of the cross-platform Cordova codebase (found in the www folder) is well documented through comments, although more details may be desirable. At this time, however, there is insufficient documentation for much of the platform specific code (especially Android java files.) There are future plans to better document the code to make forking and contributing to this project easier.

Development

Atmos Weather is written in HTML, CSS, JavaScript, and Java. Atmos Weather uses Apache Cordova to build for multiple platforms. Developed by Atticus Cornett. Please do not attempt to contribute until after the 2022 Congressional App Challenge is finished. Development plans and progress and be viewed on the Atmos Weather Notion Site: https://atticuscornett.notion.site/atticuscornett/00bc25c1bb07405d9bbe8c8c33ad195a

This project was originally created for the 2022 Congressional App Challenge.

atmosweather's People

Contributors

atticuscornett avatar djtpj avatar

Stargazers

 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.