matheustrres/weather-wise-travel

Easy-to-use API for obtaining weather forecasts for up to 15 days to make it easier to plan appointments based on the weather

WeatherWiseTravel

Easy-to-use tool for obtaining weather forecasts for up to 15 days to make it easier to plan appointments based on the weather

• Environment variables
• Running locally
• Running tests
• Documentation
• Used tools
• License

Environment variables

To run this project, you will need the following environment variables:

NODE_ENV=""

GEOCODE_API_KEY=""

VISUAL_CROSSING_API_KEY=""

Remember to create your .env file properly:

cp -r .env.sample .env

cp -r .env.sample .dev.env

Generating Geocoding API Key

To obtain a Geocoding API Key, follow the steps below:

• Head to Geocoding platform, register if it's your first time or just log in.

• Copy the generated API Key as the value of the GEOCODE_API_KEY environment key into the .env file.

Generating VisualCrossing API Key

To obtain a VisualCrossing API Key, follow the steps below:

• Head to VisualCrossing platform, register if it's your first time or just log in.

• In the top navigation bar on the right, click on the Account button.

• Copy the value of Key as the value of the VISUAL_CROSSING_API_KEY environment key into the .env file.

Running locally

Clone the project:

git clone https://github.com/matheustrres/weather-wise-travel.git

Enter the project directory:

cd weather-wise-travel

Install the necessary dependencies:

pnpm install

Build the project after installing the dependencies:

pnpm prestart

Start the server:

pnpm start

Running tests

To run the tests, execute the following command:

pnpm test

Documentation

• Get the weather forecast for up to 15 days for an address

  GET /api/v1/forecast/timeline?address=Wall Street

Parameter	Type	Description
address	string	Required. The target address

Used tools

• Node.js
• Typescript
• APIs: VisualCrossing, Geocoding Maps

License

This project is licensed under the GPL 3.0 license.