This repository contains the starter files for creating a standard autocomplete-powered lookup interface. It does make any assumptions about what users will be searching though typically at WCPSS this is addresses.
Note: This requires being a member of the wcpss-geo GitHub organization.
- Navigate to https://github.com/wcpss-geo
- Click the green button to create a new repository.
- On the Create new repository page, find wcpss-geo/lookup-starter in the Repository template dropdown and select.
- Continue as usual with creating your new repository making sure to assign ownership to the proper user/organization and to give the repository a unique name.
- Download the .zip file of this repo.
- Extract the files onto your computer somewhere where you want to do your development.
- Rename the parent directory containing all the starter files to something meaninful.
- Initialize git on the parent directory (Optional)
Effort has gone into reducing the number of dependencies needed to get started with this lookup.
The following dependencies come pre-packaged with this starter template. In other words, the dependencies will be hosted on the server along with the application that uses this template. The dependency files can be found in the lib directory.
-
Bootstrap 5 (v5.2): This provides the framework for UI styling. It provides a simple way to scaffold a mobile-first, responsive page. Mobile-first design is important for WCPSS lookups as well over half of visitors to our pages do so on their phone.
-
autocomplete (v1.8.5): Provides autocomplete lookup functionality. While there are a variety of autocomplete libraries avaiable, this particular implementation is well-documented and has performed well overall.
The following dependencies pull resources from a CDN (Content Delivery Network).