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.
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.
We've included a docs
folder with a template Tech Spec and Best Practices document, though using Github's Wiki capabilities is also a good idea. This will get you started with documenting your project. Other documents and relevant information that has no other place can live in the docs
folder. Replace this paragraph with a brief breakdown of what you've included in your docs
folder.
npm install
Add the following to a file named .env
in your project directory:
VUE_APP_BASE_API_URL=<your API url>
Where would be http://localhost:3000 if you're running the backend locally, by default PORT is 3000.
To use the backend of this project in an easy way, a docker-compose
file has been included for convenience. To run this you must add a few entries to your .env
file.
DATABASE_URL=postgres://user:[email protected]:5432/dbname
DATABASE_USER=<your username>
DATABASE_PASSWORD=<your password>
DATABASE_SCHEMA=<your schema>
The DATABASE_URL
is not a very clear var name, and the string is broken down as postgres://username:password@host:port/database_name
An example of the DATABASE_URL
would be DATABASE_URL=postgres://user:pass@db:5432/dbname
You would then run the docker-compose setup with docker-compose up -d
to run the DB & API in detached mode and then npm run serve
to run the frontend.
Here is a full example of default values for our .env
file. You should be able to copy/paste this directly and it will work locally, however we STRONGLY encourage you to use custom values.
VUE_APP_BASE_API_URL=http://localhost:3000
NODE_ENV=development
DATABASE_URL=postgres://postgres:postgres@db:5432/postgres
DATABASE_USER=postgres
DATABASE_PASSWORD=postgres
DATABASE_SCHEMA=public
JWT_KEY=abc123
BYPASS_LOGIN=true
By default the backend solution will pull the latest image from Dockerhub. If you wish to keep this up to date you should run:
docker pull codeforbaltimore/bmore-responsive
You can also specify a tagged release:
docker pull codeforbaltimore/bmore-responsive:1.0.2
npm run serve
The application will be available at http://localhost:8080/
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
.
npm run build
npm run lint
How would someone use this product? Give a few examples here.
What does someone need to do to test their work? Have you included a specific testing framework or guideline (hint: you should)? Any information about testing should be added here.
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
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!