DataMade code challenge submission

[haowens]

Overview

This PR is the filled in implementation of basic functionality of DataMade's Parserator [which takes input strings that represent addresses (like 123 main st chicago il) and displays a table of the address broken up into its component parts]. This implementation also displays an error message if the imput string is invalid. Additionally, this PR contains a couple basic tests that verify the API and views.py methods are returning the correct json.

Demo

Screen.Recording.2024-08-05.at.5.22.27.p.m.mov

Notes

• Dockerfile had to be tweaked for the dev container to successfully build, shoutout to this person whose fix worked for me https://github.com/datamade/code-challenge/issues/38

Testing Instructions

To run the code in local development:

• build the dev container: docker-compose build
• start the dev server: docker-compose up
• I believe this project follows Django directory conventional structure, in terms of where relevant code is located in this repository

To test the API

• tests can be added or tweaked in tests/test_views.py
• to run the tests in that file: docker-compose -f docker-compose.yml -f tests/docker-compose.yml run --rm app

[derekeder]

@haowens thanks for submitting this PR! Overall, the code is clean and works as expected. I have a few small comments to address.

Also, could you provide a more detailed description in your pull request? We'd like to see a summary of the changes you made, a screenshot or demo description of it working, and instructions on how to run and test the code.

[derekeder]

can you share why this was added?

[haowens]

Bizarrely I have no clue. Initially assumed it was from trying different things to fix the npm install error that was coming up when I was first trying to build the dev container, but seems like I merged that to master without this file being there. Definitely didn't manually add it because I haven't consciously worked with/really thought about github's "dependabot" before. Will delete and pay more attention to staged changes in the future !