Healthcare Rollcall

In the event of a disaster, Baltimore City and the Baltimore City Health Department (BCHD) needs to be able to verify the status of all healthcare providers in the city.

• Healthcare Rollcall
  • What is this?
  • Documentation
• Project setup
  • Keeping your API up to date
  • Compiles and hot-reloads for development
  • Compiles and minifies for production
  • Lints and fixes files
  • Customize configuration
• Using this product
  • Testing
    • Using Jest for unit testing
    • Using Snyk to check for security vulnerabilities
• Sources and Links
  • Contributors ✨

What is this?

This system will provide methods for healthcare providers to check-in during disasters, and update their information during non-emergency periods. During an emergency this system will track providers responses to a questionnaire. This questionnaire can be specific to a single disaster, or can be more general. Examples:

• Widespread power blackout
• Epidemic or Pandemic response (COVID-19)
• Natural disaster

This system will make use of digital services and modern methodologies to automate parts of the check-in process to help the city prioritize its call list and response plan. Additionally, the system will validate contact information regularly during non-emergency times to ensure the city has the most up-to-date information for each provider.

Documentation

More documentation can be found in the Docs folder.

Project setup

The quickest way to get started is using the included docker-compose to build a complete local stack (web, api, and database) of the project.

Add the following to a file named .env in your project directory:

PORT=3000
VUE_APP_BASE_API_URL=http://localhost:3001
VUE_APP_API_VERSION=1
DATABASE_PASSWORD= # Custom value
JWT_KEY= # Custom value

• PORT: The port the web service will be exposed on the host machine. Default: 3000
• VUE_APP_BASE_API_URL: The URL to the api service, includes hostname and port. Default: http://localhost:3001.
• DATABASE_PASSWORD: The password used to authenticate to the postgres database. For security, use a custom value.
• JWT_KEY: A secret value to generate JSON Web Tokens (JWTs) locally. For security, use a custom value.

You would then run the docker-compose setup with docker-compose up -d --build to run the DB & API, build the front end and stand up all containers. Once this command completes, wait 5-30 seconds for the db scripts to finish and you'll be able to access your own Healthcare Rollcall app at https://localhost:3000.

Keeping your API up to date

By default the backend solution will pull the master branch of Bmore-Responsive. If you wish to keep this up to date you should run:

docker-compose build

You can also specify a tagged release by setting the API_TAG value in your .env file:

API_TAG=1.3.2

For more information on valid API_TAG values, see: docker build - Git repositories

Compiles and hot-reloads for development

Using docker-compose will mount your local ./src directory into the application, which allows you to continue to make changes and view them within the application.

The application will be available at http://localhost:3000/.

User Credentials: To find example user credentials, look to the user.json file in the Bmore-Responsive repository.

Note: Depending on the OS you are running Docker on your localhost may be mapped to a different IP address. The standard IP address Docker is mapped to on Windows is 192.168.99.100 so you would access the application at 192.168.99.100:8080.

Compiles and minifies for production

npm run build

Lints and fixes files

npm run lint

Customize configuration

See Configuration Reference.

Using this product

How would someone use this product? Give a few examples here.

Testing

Using Jest for unit testing

`npm test`
`yarn test`

Using Snyk to check for security vulnerabilities

`npm install snyk -g`
`snyk test`

Sources and Links

We are also building a back-end API to feed and manage data for this project. To view that project, or to contribute to it, please visit the repo here: https://github.com/CodeForBaltimore/Bmore-Responsive

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Jason Anton 💻 📖 🛡️	Ati Ok 💻 👀	Harry Respass 💻 👀	Cameron Avelis 💻 👀	joffutt4 💻 👀	MGardner02 💻 👀	Mark Adkins 💻 📖 🎨
Wilner Charles 💻	Jason Bixon 💻 🎨 🚇	Snyk bot 🛡️	Dependabot 🛡️	Stephanie 🖋	c-w-allen 💻	blakenan-bellese 📖
Ian Adams 💻	Josh Glazer 💻

This project follows the all-contributors specification. Contributions of any kind welcome!