https://github.com/mit-spatial-action/who-owns-mass-frontend

Svelte/Mapbox Frontend for Who Owns Massachusetts Application.
https://github.com/mit-spatial-action/who-owns-mass-frontend

bulma-css housing landlords mapbox mapbox-gl-js mapping property svelte sveltekit

Last synced: about 2 months ago
JSON representation

Svelte/Mapbox Frontend for Who Owns Massachusetts Application.

• Host: GitHub
• URL: https://github.com/mit-spatial-action/who-owns-mass-frontend
• Owner: mit-spatial-action
• Created: 2024-02-16T18:49:06.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-04-08T15:03:14.000Z (about 2 months ago)
• Last Synced: 2025-04-08T15:47:12.827Z (about 2 months ago)
• Topics: bulma-css, housing, landlords, mapbox, mapbox-gl-js, mapping, property, svelte, sveltekit
• Language: Svelte
• Homepage:
• Size: 17.3 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Who Owns Massachusetts Frontend

[![Netlify Status](https://api.netlify.com/api/v1/badges/2c1b6580-ad37-4653-806f-b085e9e85e09/deploy-status)](https://app.netlify.com/sites/who-owns-mass-frontend/deploys)

![Screenshot of the Who Owns Massachusetts Interface](static/who-owns-mass-frontend.png)

This is the codebase for the front end of the Who Owns Massachusetts application. It's built using Svelte and SvelteKit and draws on the Bulma CSS/SCSS framework. Both production and staging branches available at...

+ [Production](https://who-owns-mass-frontend.netlify.app/): Builds from [`main`](https://github.com/mit-spatial-action/who-owns-mass-frontend/tree/main) branch.

+ [Staging](https://staging--who-owns-mass-frontend.netlify.app/): Builds from [`staging`](https://github.com/mit-spatial-action/who-owns-mass-frontend/tree/staging) branch.

## Configuration

### Node

Assuming you have `node` installed, you can install all dependencies by running `npm install` from the root directory.

### .env Configuration

The application expects several environment variables in an `.env` file located in the project's root directory. These are...

```

PUBLIC_MAPBOX_TOKEN='your token here`

VITE_PUBLIC_API_URL='http://djangoserverhost'

```

Note that your Mapbox token will be exposed to the client! As such, before deploying, you should make sure that your token is appropriately scoped and that it has URL restrictions in place. 

## Running

Run `npm run dev` from the root folder. This starts a vite server (`vite dev`) and a sass watcher that watches for changes in `src/styles/style.scss.`