Skip to content

Commit

Permalink
reviewed/finished README
Browse files Browse the repository at this point in the history
  • Loading branch information
Morgan-Sell committed Nov 1, 2024
1 parent 5488711 commit 8bd5d10
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,13 @@ The application obtains data from [Visiual Crossing's API](https://www.visualcro

- [Installation](#installation)
- [Usage](#usage)
- [Application Walkthrough](#application-walkthrough)
- [Features](#features)
- [Configuration](#configuration)
- [Dependencies](#dependencies)
- [Troubleshooting](#troubleshooting)
- [Contributing](#contributing)
- [License](#license)
- [Acknowledgement](#acknowledgement)

## Installation

Expand Down Expand Up @@ -43,9 +44,7 @@ The application obtains data from [Visiual Crossing's API](https://www.visualcro

To start the application, run the following command:

```
./run.sh run-app
```

This will:

Expand All @@ -63,7 +62,7 @@ When you access http://127.0.0.1:5001 via your web browser, you'll be greeted by
</p>

### 2. Submit Location
Enter the name of your desired city into text box.
Enter the name of your desired city in the text box.

<p align="center">
<img src="./static/img/submit.png" alt="Submission"/>
Expand Down Expand Up @@ -93,7 +92,7 @@ You can manage the environment and dependencies using `run.sh`:
## Configuration
- **Redis Configuration:** The application relies on Redis to cache weather data. The Redis server starts automatically through `run.sh run-app`, but you may need to ensure it is accessible and configured properly.

- **Weather API Key:** Obtain an API key from your preferred weather service provider and add it to the `.env` file.
- **Weather API Key:** Obtain an API key from Visiual Crossing and add it to the `.env` file.

```
API_KEY=<your_weather_api_key>
Expand All @@ -107,7 +106,7 @@ All the required dependencies can be found in `requirements.txt`. The dependenci

- **Environment Variables:** Missing environment variables will prevent the application from running. Ensure they are correctly defined in your `.env` file.

- **Redis Issues:** Redis will automatically start when `run.sh run-app`. If Redis is not properly terminated, the Redis server may enter a "stopped" or "zombie" stated preventing the application from properly functioning. If this occurs follow the following steps:
- **Redis Issues:** Redis will automatically start when `run.sh run-app`. If Redis is not properly terminated, the Redis process may enter a "stopped" or "zombie" state preventing the application from properly functioning. If this occurs follow these steps:

1. Check if Redis is already running on your system.

Expand All @@ -116,14 +115,14 @@ All the required dependencies can be found in `requirements.txt`. The dependenci
```
This will show any existing Redis processes. Look for a process running on port 6379.

2. If a Redis process is running, kill the process.
1. If a Redis process is running, kill the process.

```
sudo kill -9 <pid>
```
Replace <pid> with the process ID of the running Redis server.

3. Confirm the process has been terminated by reruning:
1. Confirm the process has been terminated by rerunning:

```
ps aux | grep redis
Expand Down

0 comments on commit 8bd5d10

Please sign in to comment.