README.md

SIGNAL

About

All Rhode Islanders have the right to live a healthy and happy life. We all need resources to help us and our families thrive at home, work, or school. But we don't all get these same opportunities because of where we live. This means that some communities are affected by COVID-19 more than others.

At Project SIGNAL, we use data to show how COVID-19 has impacted the hardest-hit neighborhoods. We make this data available to support policies that protect the most vulnerable Rhode Islanders.

Technical Details

This is a web-based project built on the Vue Framework, a progressive javascript framework. It is hosted on Firebase, Google's mobile and web app development platform. It uses Firestore, a flexible and scalable NoSQL cloud database build on Google Cloud infrastructure, to store and sync data.

We use Mapbox, customizable maps, along side Vega, a visualization grammar, to visualize data on our dashboard maps.

Getting Started with SIGNAL

❗ For in depth details on project set up, navigate to the README.md in the scripts folder. Located here.

Requirements

Node version: 18+

For the map to work, you'll need a .env file in your project root directory with the following key for a mapbox access token.

VITE_MAPBOX_ACCESS_TOKEN=

Installation

# install dependencies
$ npm install

Compiles and hot-reloads for development

# serve with hot reload at localhost:5173
$ npm run dev

Linting

$ npm run lint # report and fix linting errors

build for production and launch server

$ npm run build
$ npm run serve

Admin Setup

In order to upload data, see the README.md file in the scripts folder for more detailed instructions on setup and required scripts. Located here.