Git Product home page Git Product logo

gosyncmls's Introduction

GoSyncMLS!

gosync A Go application designed to fetch historical property listings and periodically update your local database with new listings from the MLS Grid API.

Features

  • Data Synchronization: Keeps local property listings in sync with the latest data from MLS Grid.
  • Error Handling: Implements retries on API request failures, ensuring data consistency.
  • Rate Limiting: Monitors and respects API usage limits to prevent overuse.
  • Concurrent Processing: Efficiently processes data using Goroutines, ensuring optimal performance.
  • Logging: Provides detailed logs for monitoring and debugging purposes.

Why Go?

  • Concurrency: Go's built-in Goroutines and channels make concurrent processing straightforward.
  • Performance: Go offers fast execution and efficient memory usage.
  • Simplicity: The language's clean syntax allows for quick development and easy maintenance.
  • Static Typing: Helps catch type-related errors early in the development process.

Getting Started

Prerequisites

  • Install Go (version 1.15 or higher recommended).
  • A functional database setup (e.g., PostgreSQL).
  • An active MLS Grid account to obtain the API bearer token.

Installation

  1. Clone the repository:

    git clone https://github.com/piotrsenkow/gosyncmls.git
    cd gosyncmls
  2. Install the required Go packages:

    go mod download
  3. Setup required database by running the db_schema.sql script in an SQL shell or editor. Test connection. The go program will not run if it cannot find the database and its tables.

Configuration

Set up the required environment variables:

  • API_BEARER_TOKEN: Your MLS Grid API bearer token. Obtain one by applying for a data license at mlsgrid.com.
  • DB_CONN_STRING: Your postgreSQL connection string. Example: postgresql://user:password@localhost:5432/mred

Running the Application

Execute the command go run main.go from the project directory.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT License. See the LICENSE file for details.

gosyncmls's People

Contributors

piotrsenkow avatar

Watchers

 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.