https://github.com/arpitgo4/metar_api

Metar API server with caching for fast responses.
https://github.com/arpitgo4/metar_api

docker docker-compose expressjs metar metar-information nginx nodejs redis weather-api weather-data weather-forecast weather-station

Last synced: 1 day ago
JSON representation

Metar API server with caching for fast responses.

• Host: GitHub
• URL: https://github.com/arpitgo4/metar_api
• Owner: arpitgo4
• Created: 2019-03-30T05:22:48.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-04-16T10:58:51.000Z (over 5 years ago)
• Last Synced: 2024-11-08T17:50:48.882Z (about 2 months ago)
• Topics: docker, docker-compose, expressjs, metar, metar-information, nginx, nodejs, redis, weather-api, weather-data, weather-forecast, weather-station
• Language: TypeScript
• Homepage:
• Size: 111 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# Metar API

Metar API with redis cache for fast and reliable metar weather data.

## Project Structure

```

        .

        ├── api-gateway                 #  Nginx Api Gateway

        ├── deployment

        |   ├── development             #  Docker-compose development config

        |   └── production              #  Docker-compose production config

        ├── server                      #  Api Server

        └── README.md                   #  This file

```

## Postman API Sheet

```

## Postman api collection

https://documenter.getpostman.com/view/401954/S17wP6VP

```

## Environment Variables

```

## Environment variables are defined in the deployment/[production/development]/docker-compose.yml

## Environment variables are needed for successfull startup of the server

SERVER_PORT=8080                        # Port number for server to listen

REDIS_HOST=redis_cluster_ip:6379        # Redis connection url

NODE_ENV=production                     # Server environment to run

REDIS_METAR_EXPIRY=5                    # Redis expiration time for metar info

API_GATEWAY=api_gateway                 # Api gateway service domain name

```

## Development

```

# Start project in development mode with hot code loading,

cd deployment/development && docker-compose up --build [-d]

# See logs for a container (service in docker-compose)

cd deployemnt/development && docker-compose logs --follow 

# Get container (service) shell access

cd deployment/development && docker-compose exec  sh

# Enjoy developing :)

```

## Production

```

# Start project in production mode,

cd deployment/production && docker-compose up --build

# Open web browser at http://localhost/api/v1/ping

# You will see a response : { data: 'pong' }

```

## Feedback

In case of any query or feedback, please feel free to connect via

* [email protected] (Arpit Goyal)

Or, open an issue at github.