code-challenge icon indicating copy to clipboard operation
code-challenge copied to clipboard

working functionality

Open chuymedina96 opened this issue 1 year ago • 0 comments

Overview

This PR implements the address parser functionality, allowing users to parse US addresses into components such as AddressNumber, StreetName, and ZipCode. It includes:

  • A Django API endpoint to handle address parsing.
  • JavaScript to interact with the API and display results.
  • Unit tests to ensure the parser works correctly and handles errors.

Closes #XXX

Demo

Optional. Screenshots, curl examples, etc.

Notes

  • Added error handling for invalid addresses.
  • Utilized modern JavaScript features for better code readability and maintainability.

Testing Instructions

  1. Check out this branch.

  2. Ensure Docker is installed.

  3. Run the following command to start the services and run the tests: docker-compose -f docker-compose.yml -f tests/docker-compose.yml run --rm app

  4. Tests should pass, and the linter should not report any errors.

  5. Open the app in the browser and test the address parser by submitting a valid and invalid address.

  6. Expected output: Valid addresses should be parsed into components; invalid addresses should display an error message.

  • How to test this PR
  • Prefer bulleted description
  • Start after checking out this branch
  • Include any setup required, such as bundling scripts, restarting services, etc.
  • Include test case, and expected output

chuymedina96 avatar Jul 24 '24 15:07 chuymedina96