ihavebadfantasy/weather-test-task

Weather App test task

Weather App

This project fetches weather data from OpenWeatherMap API and stores it in a PostgreSQL database. The project provides two accessible APIs:

1. POST API:

   • Endpoint: /weather
   • Accepts lat, lon, and part parameters.
   • Fetches data from the OpenWeatherMap API and stores it in the database.

2. GET API:

   • Endpoint: /weather
   • Accepts lat, lon, and part parameters.
   • Retrieves weather data from the database based on the provided latitude, longitude, and part parameters.

Requirements

• Docker should be installed on your machine and running.

Running the Project

1. Clone the Repository:

   git clone https://github.com/your-username/weather-app.git
   cd weather-app

2. Copy the .env file from the .env.example and complete the fields with correspondent values:

   cp .env.example .env

3. Build and Run the Docker Containers:

    docker-compose up --build

4. Access the Application:

• Nest.js API: http://localhost:3000
• pgAdmin: http://localhost:5050
  • Email: in .env
  • Password: in .env

API Documentation:

Swagger documentation is available at http://localhost:3000

Notes:

• The application uses a PostgreSQL database to store weather data. Data is stored in JSON format. On the first start the error may occur from TypeORM module of Nest.js app, saying unable to connect to database. It occurs because database is being created and initialized at the first time, when container with database server is already successfully running. I have tried to resolve the issue using external scripts/tools to create a delay but app did not respond inside the container. The error does not influence the work of app and containers, app will automatically reconnect when database is ready and will be ready to receive requests.
• Unit tests are optional and not included in this example.