Skip to content

Latest commit

 

History

History
28 lines (16 loc) · 1.35 KB

README.md

File metadata and controls

28 lines (16 loc) · 1.35 KB

NC State Library Busyness Frontend

This repository contains the React-based frontend for the NC State Library Busyness tracker project.

Technologies

This site uses Vite + TypeScript + React, with Tailwind CSS for styling and recharts for data visualization. This branch's version of the site is deployed on Cloudflare pages.

The backend is kept in a separate (private, for now) repository, and is based on AWS serverless infrastructure.

Development

Use the scripts provided in package.json to serve the site locally. Be sure to include a .env with the following variables:

  • REACT_APP_HISTORICAL_RECORDS_API_URL
  • REACT_APP_FORECASTS_API_URL
  • REACT_APP_METRICS_API_URL

When contributing, use Prettier with the configuration provided at the top level of this repository.

Config

  • See this stackoverflow post for why there are multiple tsconfig files
  • Whenever the use of a new environment variable is required, it must be added to vite.config.ts

Deployment

Cloudflare pages is set to automatically deploy from this branch when it is committed to.