Code Monkey home page Code Monkey logo

radman_business_searcher's Introduction

Business Search Tool Backend

The backend for the Business Search Tool, built with Python and the FastAPI framework. This backend serves as the API for the frontend to retrieve information about businesses in a specific area of the US.

API Overview

The backend API performs the following steps to retrieve information about businesses in a specific area:

  1. Calls the Google Places textsearch API with a text search string based on frontend queries to get back a list of businesses that have place IDs and a little bit of other information.
  2. Filters the list by total number of reviews.
  3. Calls the Google Place Details API for each place ID to get the business's website.
  4. Returns the list of websites and number of reviews associated with each place to the frontend.

Getting Started with the Business Search Tool Backend

Follow these steps to get the backend API up and running on your local machine.

Prerequisites

Installation

  1. Clone the repository
  2. Navigate to the backend directory
  3. Install the dependencies: pip install -r requirements.txt
  4. Set the Google Places API Key as an environment variable: export API_KEY="your_api_key_here"
  5. Start the development server: uvicorn main:app --reload
  6. Access the API at http://localhost:8000/docs

Deployment

The backend is hosted on Google Cloud Run via a Docker container. Follow the documentation for Google Cloud Run to deploy the backend API. Ensure you have a correctly written Dockerfile in your source directory. ALSO when deploying the container to any cloud service, check the service settings to ensure it is listening on the correct HTTP (10000) to match the container.

Contributing

This project is open for contributions. Feel free to open an issue or submit a pull request.

radman_business_searcher's People

Contributors

dennis-nichols avatar

Stargazers

DeShon Dixon 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.