Giter Club home page Giter Club logo

api-weather-buddy's Introduction

Welcome to Weather Buddy ☂️

An app that consumes Open Weather Api maps the response and cache the result. Builded with nodejs

ℹ️ How to use the api

git clone https://github.com/lucaskbr/api-weather-buddy.git
cd api-weather-buddy
cp .env .env.example
# Edit the .env and add value to WEATHER_MAP_API_KEY
npm i
# Check tests
npm run test
# Run the app
npm run up:prod
# Docker compose will handle the app

🔥 How to use the front-end interface

git clone https://github.com/lucaskbr/front-weather-buddy.git
yarn
yarn start
# Can use any port to run the app

🔍 Inspect redis data

docker ps
docker exec -it CONTAINER_ID redis-cli
KEYS *
GET key

✈️ Routes

METHOD URI DESCRIPTION
GET /weather/:cityName find weather by city name
GET /weather?max=number find latestes searched cities

🏢 Architecture

The hexagonal architecture, or ports and adapters architecture, is an architectural pattern used in software design.

It aims at creating loosely coupled application components that can be easily connected to their software environment by means of ports and adapters.

This makes components exchangeable at any level and facilitates test automation.

📕 References

👓 Author

api-weather-buddy's People

Contributors

lucaskbr avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.