Skip to content

Commit

Permalink
(docs) Visual updates to README
Browse files Browse the repository at this point in the history
  • Loading branch information
denniskigen committed Jun 23, 2022
1 parent 1e4b893 commit e1f73ac
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
# react-weather [![build](https://github.com/denniskigen/react-weather/actions/workflows/ci.yml/badge.svg)](https://github.com/denniskigen/react-weather/actions/workflows/validate.yml) ![Deployment status](https://img.shields.io/github/deployments/denniskigen/react-weather/production?label=vercel&logo=vercel&logoColor=white) [![Coverage Status](https://coveralls.io/repos/github/denniskigen/react-weather/badge.svg?branch=main)](https://coveralls.io/github/denniskigen/react-weather?branch=main)
<div align="center">
<img height="72" width="72" src="./public/logo.svg" alt="App logo" />
</div>

> If you like React Weather, you'll :heart: [React Weather Next](https://react-weather-next.denniskigen.com)!
![Landing page screenshot](./public/screenshot.png)

React Weather is a beautiful weather app that uses the [OpenWeatherMap API](https://openmweathermap.org/api).
[![build](https://github.com/denniskigen/react-weather/actions/workflows/ci.yml/badge.svg)](https://github.com/denniskigen/react-weather/actions/workflows/validate.yml) ![Deployment status](https://img.shields.io/github/deployments/denniskigen/react-weather/production?label=vercel&logo=vercel&logoColor=white) [![Coverage Status](https://coveralls.io/repos/github/denniskigen/react-weather/badge.svg?branch=main)](https://coveralls.io/github/denniskigen/react-weather?branch=main)

[See it live](https://react-weather.denniskigen.com)

![Home page](https://github.com/denniskigen/react-weather/blob/main/public/screen.png)
[React Weather](https://react-weather.denniskigen.com) is a beautiful weather app built on top of the [OpenWeatherMap API](https://openmweathermap.org/api).

## Getting started

- Sign up over at [openweathermap.org](https://openweathermap.org/appid) and get an API key.
- Fork the project and clone it locally.
- Create a file at the root of the project called `.env.local` with the following contents:
- Install dependencies using [pnpm](https://pnpm.io/installation):

```sh
VITE_API_URL = 'https://api.openweathermap.org/data/2.5'
VITE_API_KEY = The API key you obtained from openweathermap.org
VITE_ICON_URL = 'https://openweathermap.org/img/w'
pnpm install
```

- Install dependencies using [pnpm](https://pnpm.io/installation):
- Create a file at the root of the project called `.env.local` with the following contents:

```sh
pnpm install
```
VITE_API_URL = 'https://api.openweathermap.org/data/2.5'
VITE_API_KEY = The API key you obtained from openweathermap.org
VITE_ICON_URL = 'https://openweathermap.org/img/w'
```
1 change: 1 addition & 0 deletions public/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified public/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit e1f73ac

@vercel
Copy link

@vercel vercel bot commented on e1f73ac Jun 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.