Git Product home page Git Product logo

sffoodtruckservice's Introduction

sfFoodTruckService

Lambda function to get food truck data from a San Francisco database.

Table of Contents

  1. Usage
  2. Requirements
  3. Development
    1. Installing Dependencies
    2. Serving in Development
    3. Testing
    4. Style Guide
  4. Given More Time
  5. Roadmap
  6. Notes On Data Filtering

Usage

The purpose of this service is to filter approved food truck permits in SF.

Requirements

  • Node 8.10
  • serverless 1.38.0 or higher: serverless docs

Development

Installing Dependencies

From within the root directory:

yarn

Create a .config.dev.json for API keys

touch .config.dev.json

Then add something like the following:

{
  "dev": {
    "GOOGLE_MAPS_APIKEY": "Replace this with your api key"
  },
  "prod" : {
    "GOOGLE_MAPS_APIKEY": "Replace this with your api key"
  }
}

Serving in Development

From within the root directory:

sls deploy

For more information check the serverless docs

Testing

From within the root directory:

Server side testing:

yarn test

Style Guide

For this project I'm using the popular Standard JS Style Guide. Eslint is installed to help keep styles consistent.

Given More Time

Given more time, I would impliment integration tests for the AWS Lambda service. If this were a production quality service the integration tests would be a necessity.

If I could start this project over again, I would have prioritized integration testing sooner. I would use the popular supertest module for this.

Roadmap

  • Add ability map Yelp data to a business before returning results.
  • Include a deeplink to Yelp for more information.

Notes on Data Filtering:

  • This service will only return food trucks located in San Francisco that have currently approved permits.

sffoodtruckservice's People

Contributors

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