https://github.com/divyansharma001/uvprotect

Provides UV forecast to save user from harmful UV rays
https://github.com/divyansharma001/uvprotect

bootstrap ejs expressjs hacktoberfest hacktoberfest-accepted javascript

Last synced: 3 months ago
JSON representation

Provides UV forecast to save user from harmful UV rays

• Host: GitHub
• URL: https://github.com/divyansharma001/uvprotect
• Owner: divyansharma001
• Created: 2024-01-21T07:21:30.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-03-17T17:11:12.000Z (over 2 years ago)
• Last Synced: 2025-12-31T14:45:23.920Z (6 months ago)
• Topics: bootstrap, ejs, expressjs, hacktoberfest, hacktoberfest-accepted, javascript
• Language: EJS
• Homepage: https://uvsafe.onrender.com/
• Size: 26.9 MB
• Stars: 1
• Watchers: 1
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# UV Safe

**Description**

This Node.js web application fetches UV index data and location information for a given latitude and longitude. It utilizes the OpenCageData API for geocoding and the Open UV API for UV data retrieval. The retrieved information is then displayed on an EJS template. The goal is to help users take preventive measures to protect themselves from harmful UV rays.

  

  

**Key Features**

- Retrieves UV index data for the next 11 hours.

- Displays location details (city, state, country).

- Converts UTC timestamps to India Standard Time (IST) for user convenience.

- User-friendly interface built with EJS templates.

**Prerequisites**

- Node.js and npm (or yarn) installed on your system.

- An OpenCageData API key ([https://opencagedata.com/](https://opencagedata.com/))

- An Open UV API key ([https://www.openuv.io/index.html](https://www.openuv.io/index.html))

**Installation**

1. Clone this repository:

   ```bash

   git clone https://github.com/your-username/your-project-name.git

   ```

2. Navigate to the project directory:

   ```bash

   cd your-project-name

   ```

3. Install dependencies:

   ```bash

   npm install

   ```

**Configuration**

1. Create a `.env` file in the project root directory.

2. Add the following environment variables to the `.env` file, replacing the placeholders with your actual API keys:

   ```

   OPEN_CAGE_KEY=your_opencagedata_api_key

   OPEN_UV_KEY=your_openuv_api_key

   ```

**Running the Application**

1. Start the development server:

   ```bash

   npm start

   ```

2. Open http://localhost:3000 in your web browser.

**Usage**

1. Enter valid latitude and longitude values in the input fields on the web page.

2. Click the "Submit" button.

The application will retrieve the UV index data and location information for the specified coordinates and display it on the page.

**Screenshots**

* **Home Page:**  ![Home page screenshot](./public/images/homePage.png)

* **Location fetching:** ![Home page screenshot](./public/images/locationPage.png)

* **Guidelines:** ![Home page screenshot](./public/images/guidelines.png)

* **QnA:** ![Home page screenshot](./public/images/lastPage.png)

**Contributing**

We welcome contributions to this project! Feel free to fork the repository, make changes, and submit a pull request. Before contributing, please review the following guidelines:

- Adhere to the existing code style and formatting.

- Include clear and concise comments in your code.

- Write unit tests for your changes.

- Ensure your code passes all existing tests before submitting a pull request.

**Additional Notes**

- Error handling is included to gracefully handle invalid user input or API errors.

- The code is well-structured and uses promises for asynchronous operations.

- Feel free to customize the application further by adding features or changing the UI design.