Welcome to our project! Our goal is to provide an easily accessible search utility for residents of Wyandotte County, KS to find properties within the county's land bank. Currently, the only resource made available to residents is an interactive map, which, while helpful, is not entirely accessible to the average user. We want to allow residents to enter their requirements, and receive a list of relevant properties. They can then decide to apply, or contact the land bank for further information.
This project will consist of a React.js frontend application, and a Flask backend application. All user interface related functionality is handled on the frontend, while the backend handles storing submitted data and authentication. The two will communicate via a REST api. The unique feature our app provides that isn't found in most search utilities is an application assistant, which will comprise a logic-controlled form that prompts the user to provide only as much information as necessary via question trees, and a backend app which returns relevant application documents to the user after the questions are finished, with sections of the documents completed with submitted data. The goal of this is to simplify the steps of the application process, and de-mystify the steps to gaining ownership of land bank properties.
To contribute to this project, push any local changes into a new branch, and submit a pull request for the group to review before merging.
- To get started, clone the
frontendbranch into a local folder. - Open the folder
frontendin your favorite code editor, and run 'npm install' in a new terminal to install the project's dependencies found in thenode_modulesfolder. - Once all dependencies are installed, run
npm startto open the app in development mode. The app supports hot reloading, so all changes are automatically included without having to recompile. - Happy coding!
The app is structured to have each piece of functionality separated into its own component, ie all navigation related concerns will be in the navigation component, and the search related concerns will be in the search component. Each component lives in its own folder, inside an index.jsx file to allow for simplified imports. State management notes coming soon.
To be determined after discussion.
Our design reference for the app's frontend can be found at figma.com. The app's frontend is created with Material-UI, and the reference for its components is available at material-ui.com Our property data is being pulled from an ArcGIS database via a REST API, and its reference is located at wycokck.org