Skip to content

Commit eb68b9a

Browse files
andrewevans0102andrewevans0102
authored
Merge pull request andrewevans0102#4 from andrewevans02/updating-documentation
Updating documentation
2 parents 6d156e6 + 689d907 commit eb68b9a

File tree

6 files changed

+46
-61
lines changed

6 files changed

+46
-61
lines changed

‎README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
# Goose Weather
22
![goose image](/src/assets/goose.svg)
3-
- Project built with Angular 7
4-
- Project uses NOAA APIs [here](https://www.weather.gov/documentation/services-web-api)
5-
- Project is hosted on Firebase [here](https://firebase.google.com/)
6-
- Project CICD pipeline is managed with CirlceCI [here](https://circleci.com/)
7-
- Used Angular CDK Schematic to generate the tiles and the hourly forecast
8-
- Angular Schematics can be seen [here](https://material.angular.io/guide/schematics)
9-
- Also used dynamic component generation with the ngComponentOutlet
10-
- Application also makes use of NgRx Store and Effects
3+
4+
- Weather application that I named for my wife, and her dream of being a meteorologist
5+
- Application is built with Angular and uses [NOAA APIs](https://www.weather.gov/documentation/services-web-api) and the [OpenWeatherMapAPI Service](https://openweathermap.org/api) to create a weather forecast
6+
- Application uses the following platforms and frameworks:
7+
- [NgRx](https://ngrx.io/)
8+
- [Angular Material](https://material.angular.io/)
9+
- [Bootstrap](https://getbootstrap.com/)
10+
- [Firebase](https://firebase.google.com/)
11+
- [CircleCI](https://circleci.com/)
12+
- Visit the hosted site at https://www.gooseweather.com
1113

1214
## Open Weather Map API
1315
- In order to get current conditions, this application uses the Open Weather Map API [here](https://openweathermap.org/api)
1416
- In order to use Open Weather MAP API, you'll need to create a key [here](https://openweathermap.org/appid)
15-
- You'll also need to export an environment variable with the key name to $OPEN_WEATHER_MAP_API_KEY
17+
- You'll also need to export an environment variable with the key name to `$OPEN_WEATHER_MAP_API_KEY`
1618
- Once you've created your key and saved the variable in your bash_profile or current session run the npm script `environment-variables` to populate the key value to the project's environment files

‎src/app/cards/about-desktop/about-desktop.component.css

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,12 @@
66
font-size: 1.5em;
77
}
88

9-
ul {
10-
width: 40em;
11-
}
12-
139
li {
1410
text-align: left;
1511
}
1612

1713
img {
1814
display: flex;
19-
align-content: center;
20-
padding: 1em;
21-
margin-bottom: 10em;
15+
justify-content: left;
16+
margin-top: 1em;
2217
}

‎src/app/cards/about-desktop/about-desktop.component.html

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
11
<div class="about">
22
<ul>
3-
<li>Written with <a href="https://github.com/angular/angular">Angular 7</a> with <a href="https://github.com/ngrx/platform">NgRX</a></li>
4-
<li>Styling done with <a href="https://material.angular.io/">Angular Material</a> and <a href="https://getbootstrap.com/">Bootstrap</a></li>
5-
<li>Weather Data retrieved with the <a href="https://www.weather.gov/documentation/services-web-api">NOAA API</a> and
6-
<a href="https://openweathermap.org/api">Open Weather Map API</a></li>
7-
<li>Project is Open Source and can be viewed on GitHub <a href="https://github.com/andrewevans02/goose-weather">here</a></li>
8-
<li>Open Source with the <a href="https://github.com/andrewevans02/goose-weather/blob/master/LICENSE">MIT License</a></li>
9-
<li>Angular image was copied from <a href="https://upload.wikimedia.org/wikipedia/commons/thumb/c/cf/Angular_full_color_logo.svg/250px-Angular_full_color_logo.svg.png">here</a></li>
10-
<li>Goose Picture was made at <a href="https://www.flaticon.com/authors/smalllikeart" title="smalllikeart">smalllikeart</a> from
11-
<a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a> is licensed by
12-
<a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0" target="_blank">CC 3.0 BY</a></li>
13-
<li>Temperature displayed is in Fahrenheit</li>
14-
<li>Speed displayed is in Miles Per Hour</li>
3+
<li>Angular Application built and maintained by <a href="https://rhythmandbinary.com/">Andrew Evans</a></li>
4+
<li>Weather data provided by <a href="https://www.weather.gov/documentation/services-web-api">NOAA APIs</a> and the <a href="https://openweathermap.org/api">OpenWeatherMapAPI Service</a></li>
5+
<li>Application uses <a href="https://ngrx.io/">NgRx</a> for state management</li>
6+
<li>Open Source with the
7+
<a href="https://github.com/andrewevans02/goose-weather/blob/master/LICENSE">MIT License</a> and can be viewed on <a href="https://github.com/andrewevans02/goose-weather">GitHub</a></li>
8+
<li>Goose image was made at
9+
<a href="https://www.flaticon.com/authors/smalllikeart" title="smalllikeart">smalllikeart</a> from
10+
<a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a>
11+
and is licensed by
12+
<a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0" target="_blank">CC 3.0 BY</a>
13+
</li>
1514
</ul>
16-
<img src='./assets/goose.svg'>
17-
<img src='./assets/Angular.png'>
1815
</div>
16+
<img src='./assets/goose.svg'>

‎src/app/cards/about-mobile/about-mobile.component.css

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
ul {
2-
width: 20em;
1+
.about {
2+
display: flex;
3+
flex-direction: row;
4+
justify-content: left;
5+
flex-wrap: wrap;
36
}
47

58
li {
6-
font-size: 1em;
79
text-align: left;
810
}

‎src/app/cards/about-mobile/about-mobile.component.html

Lines changed: 15 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,16 @@
1-
<div class="container">
2-
<div class="row">
3-
<div class="col-sm">
4-
<ul>
5-
<li>Written with <a href="https://github.com/angular/angular">Angular 7</a> with <a href="https://github.com/ngrx/platform">NgRX</a></li>
6-
<li>Styling done with <a href="https://material.angular.io/">Angular Material</a> and <a href="https://getbootstrap.com/">Bootstrap</a></li>
7-
<li>Weather Data retrieved with the <a href="https://www.weather.gov/documentation/services-web-api">NOAA API</a> and
8-
<a href="https://openweathermap.org/api">Open Weather Map API</a></li>
9-
<li>Project is Open Source and can be viewed on GitHub <a href="https://github.com/andrewevans02/goose-weather">here</a></li>
10-
<li>Open Source with the <a href="https://github.com/andrewevans02/goose-weather/blob/master/LICENSE">MIT License</a></li>
11-
<li>Angular image was copied from <a href="https://upload.wikimedia.org/wikipedia/commons/thumb/c/cf/Angular_full_color_logo.svg/250px-Angular_full_color_logo.svg.png">here</a></li>
12-
<li>Goose Picture was made at <a href="https://www.flaticon.com/authors/smalllikeart" title="smalllikeart">smalllikeart</a> from
13-
<a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a> is licensed by
14-
<a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0" target="_blank">CC 3.0 BY</a></li>
15-
<li>Temperature displayed is in Fahrenheit</li>
16-
<li>Speed displayed is in Miles Per Hour</li>
17-
</ul>
18-
</div>
19-
<div class="col-sm">
20-
<img src='./assets/goose.svg'>
21-
</div>
22-
<div class="col-sm">
23-
<img src='./assets/Angular.png'>
24-
</div>
25-
</div>
1+
<div class="about">
2+
<ul>
3+
<li>Angular Application built and maintained by <a href="https://rhythmandbinary.com/">Andrew Evans</a></li>
4+
<li>Weather data provided by <a href="https://www.weather.gov/documentation/services-web-api">NOAA APIs</a> and the <a href="https://openweathermap.org/api">OpenWeatherMapAPI Service</a></li>
5+
<li>Application uses <a href="https://ngrx.io/">NgRx</a> for state management</li>
6+
<li>Open Source with the
7+
<a href="https://github.com/andrewevans02/goose-weather/blob/master/LICENSE">MIT License</a> and can be viewed on <a href="https://github.com/andrewevans02/goose-weather">GitHub</a></li>
8+
<li>Goose image was made at
9+
<a href="https://www.flaticon.com/authors/smalllikeart" title="smalllikeart">smalllikeart</a> from
10+
<a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a>
11+
and is licensed by
12+
<a href="http://creativecommons.org/licenses/by/3.0/" title="Creative Commons BY 3.0" target="_blank">CC 3.0 BY</a>
13+
</li>
14+
</ul>
2615
</div>
27-
28-
16+
<img src='./assets/goose.svg'>

‎src/app/weather/weather.component.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ export class WeatherComponent implements OnInit {
115115
{
116116
title: 'About',
117117
cols: 3,
118-
rows: 2,
118+
rows: 1,
119119
component: AboutMobileComponent
120120
}
121121
];

0 commit comments

Comments
 (0)