Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restyle Add license scan report and status #47

Open
wants to merge 3 commits into
base: experiment
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 44 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
<div align="center">
<p align="center"> <a href="https://github.com/deep5050/minimal-weather"><img src="https://i.imgur.com/IgEQqmi.png" title="Minimal Weather"/></a> </p>
<p align="center"> <a href="https://github.com/deep5050/minimal-weather"><img src="https://i.imgur.com/IgEQqmi.png" title="Minimal Weather"/></a> </p>

<p align="center"> <h4 align="center">A Minimal But Smart Weather App Made With Electron API</h4></p>
</div>

## Default screen

![screenshot 288](https://user-images.githubusercontent.com/27947066/44948700-ef8d7d00-ae3f-11e8-98ee-76cca26d48c6.png)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fdeep5050%2Fminimal-weather.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fdeep5050%2Fminimal-weather?ref=badge_shield)

## After changing the city

Expand All @@ -21,63 +22,75 @@

No Dependencies :) :cool:


## Install


Clone this repository into your local computer then follow these steps...

1. Open Terminal/ command prompt from the directory
2. type `npm start` or `electron .`
2. type `npm start` or `electron .`
3. Enjoy.


## Build
Clone the repository and run `npm build` with [**electron-packager**](https://github.com/electron-userland/electron-packager "electron-packager repo") installed.

Clone the repository and run `npm build` with
[**electron-packager**](https://github.com/electron-userland/electron-packager "electron-packager repo")
installed.

> Run `npm install electron-packager --save-dev` to quick install

> For tutorial on how to package an app check this link [go to this link ](https://www.christianengvall.se/electron-packager-tutorial/)
> For tutorial on how to package an app check this link
> [go to this link ](https://www.christianengvall.se/electron-packager-tutorial/)

## Info
**NOTE:** Make sure you have installed NodeJs and Electron on your computer.
You can use your own API key to query (Optional)
set your home city and enjoy the app.
Thank You. :smile:

**NOTE:** Make sure you have installed NodeJs and Electron on your computer. You
can use your own API key to query (Optional) set your home city and enjoy the
app. Thank You. :smile:

## Help
help me to package this app for Mac and Linux environment.
**Windows binary version (.exe) coming soon** :smile:

help me to package this app for Mac and Linux environment. **Windows binary
version (.exe) coming soon** :smile:

## Sources
1. [openweather](https://openweathermap.org/ "openweather") ==> for providing actual weather data
2. [bootstrap](https://getbootstrap.com/ "bootstrap") ==> css library
3. [flaticon](https://www.flaticon.com/ "flaticon") ==> for cool icons

1. [openweather](https://openweathermap.org/ "openweather") ==> for providing
actual weather data
2. [bootstrap](https://getbootstrap.com/ "bootstrap") ==> css library
3. [flaticon](https://www.flaticon.com/ "flaticon") ==> for cool icons

## Lisence

MIT License

Copyright (c) 2018 dipankar pal

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

## DONATE
If this project helps you in any way making your life easier, you can buy me a :coffee: .
<p align="center">

If this project helps you in any way making your life easier, you can buy me a
:coffee: .

<p align="center">
<a href="https://www.paypal.me/deep5050" alt="Paypal"><img src="https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif" /></a>
</p>

## License

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fdeep5050%2Fminimal-weather.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fdeep5050%2Fminimal-weather?ref=badge_large)