Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 1.39 KB

README.md

File metadata and controls

32 lines (24 loc) · 1.39 KB

Tileviewer

This is the user interface for the SO Map Viewer. The client is built with React and bundled by vite. The underlying mapping components are built with leaflet.js and react-leaflet.

Steps to run locally

  1. Clone and initialize this repo:
git clone [email protected]:simonsobs/tileviewer.git
cd tileviewer
npm install
  1. Set up a .env.development file. The contents of env.development.sample should suffice if you plan to serve the map tiles using the SO Tilemaker

  2. Depending on your tile server setup:

    3A. If using the SO Tilemaker:

      # vite's dev server is configured to be on port 8080; amend as desired.
      origins: list[str] | None = ["http://localhost:8080"]
      add_cors: bool = True
    • Run the tile server locally via uvicorn tilemaker.server:app --port=9191 --reload

    3B. If using your own tile server:

    • Set the VITE_SERVICE_URL environment variable in .env.development to point to your local server
    • Run your tile server locally
  3. Run the client dev server via npm run dev