Skip to content

whubsch/atlus_website

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Atlus - parse US addresses for OpenStreetMap

This project is a web application that allows users to input US address strings and converts them into OpenStreetMap tagging format. It consists of a FastAPI backend for handling address parsing and a React frontend for the user interface, hosted at atlus.dev. There is also a phone number parsing functionality. Canadian addresses sometimes can be processed, but the backend uses the usaddress Python package with some additional logic that is geared mostly toward US addresses and address patterns.

Features

  • Address Parsing: Enter a US address, and the application will convert it into OpenStreetMap format.
  • FastAPI Backend: The backend handles the address parsing logic and provides an API endpoint for the frontend and power users.
  • React Frontend: A user-friendly interface for entering addresses and viewing the parsed results.
  • Traefik Reverse Proxy: A Traefik reverse proxy efficiently routes incoming web traffic to the front- and backend.
  • Fully Dockerized: Deploy the application on your own with Docker.

Usage

Website

  1. Enter a US address or phone number in the provided input field.
  2. Click the "Submit" button.
  3. View the parsed address in OpenStreetMap format, and optionally copy the output to your clipboard.

API

  1. Read the documentation.
  2. Submit post requests to the API path: atlus.dev/api.
  3. Abusing the API will result in bans.

Contributing

If you would like to contribute to this project, we welcome pull requests and new issues.

License

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

About

Parse US addresses into OpenStreetMap format

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published