Skip to content

Chicago/lead-safe-api-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build statusVersion

"Lead Safe" API Documentation

Building and Testing

The documentation is compiled with MkDocs and is required while testing.

Local Testing

Test changes to the documentation by opening a terminal and run

mkdocs serve

Visit localhost:8000 in a browser to inspect the documentation.

Once changes are acceptable, build the documentation by returning to the terminal and run

mkdocs build

Commit and push changes to the server.

License

Copyright © 2017 City of Chicago. Documentation is licensed under Creative Commons Attribution-ShareAlike 4.0 International.

Configuration

Emailing Forms

The application process uses Formspree.io. Currently using the free service, which limits to 1,000 submissions per month. This can be modified in the <forms> element in docs/apply.md

List of Eligible Health Networks

The list of eligible health networks is in docs/apply.md. Each institution is listed as an <option>