Code Monkey home page Code Monkey logo

sanfran-mffp-proxy's Introduction

SanFran Mobile Food Facility Permit Proxy - A coding assessment

Overview

This project is a simple proxy server that fetches data from the San Francisco Mobile Food Facility Permit API and returns it in a more user-friendly format. The API is available at https://data.sfgov.org/resource/rqzj-sfat.json.

Reasoning

The API at https://data.sfgov.org/resource/rqzj-sfat.json uses a single string query parameter to filter the data. This is not user-friendly, as it requires the user to know the exact query string to use. This project provides a more user-friendly interface by allowing the user to filter the data using query parameters in the URL.

Usage

Installation

To install the project, clone the repository and run npm install to install the dependencies.

Initialize a base .env file

NODE_ENV=development
PORT=3000

Running locally

To run the project locally, run npm run dev. The server will start on port 3000 by default.

Tech Stack

  • Node.js
  • Express.js
  • Axios
  • Nodemon (for development)

API Endpoints

Food Truck Routes

  • GET /food-trucks - Returns a list of food trucks based on the query parameters provided
    • Current Query Parameters
      • limit - The number of results to return. Default is 10.
      • offset - The number of results to skip. Default is 0.
      • where - The query string to filter the results. Default is an empty string.
      • order by - The order in which to return the results. Default is applicant ASC.

System Routes

  • GET /system/health - Returns the health status of the server.

sanfran-mffp-proxy's People

Contributors

alangreyjoy 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.