Git Product home page Git Product logo

plz-api's Introduction

Postal Code API

An API that allows searching in Switzerlands Postal Codes

Features

  • Caches Responses for 30 Minutes
  • Compresses Responses with GZIP
  • Fast JSON-Encoding

Env Vars

  • DB_CONN
  • CACHE_DURATION - in Minutes

Run Locally

air

Generate Documentation (Swagger)

Run this command

swag init

Problems in ASDF

RUn this first

asdf reshim

Build Docker Image Locally

docker build -t plz-api .

Run the Image

Database needs to be running!

docker run --rm -p 3000:3000 --name plz_api -e DB_CONN="<DB_CONN>" plz-api

Todo

  • Consider upping the time data stays in cache, because source only updates every month... Maybe to 1 Month?
  • ...

plz-api's People

Contributors

3n3a avatar

Watchers

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.