Skip to content

Latest commit

 

History

History
93 lines (58 loc) · 1.84 KB

README.md

File metadata and controls

93 lines (58 loc) · 1.84 KB
Raw

Photosphere Electron frontend

This is the Electron frontend for the Photosphere application. Built on React and bundled with Webpack.

Pre-reqs

You need Node.js installed to run this code.

Setup

First, follow the instructions in the Electron readme.

Then open a terminal and change directory to the electron/frontend project:

cd electron/frontend

To enable the frontend you must first run the backend.

Run the Webpack dev server

Run the dev server like this:

pnpm start

Then click the link or point your browser at the default location for Webpack: http://localhost:8080.

Build the static web page

Set the BASE_URL environment variable to point the frontend to the backend:

export BASE_URL=http://localhost:3000

Or on Windows:

set BASE_URL=http://localhost:3000

Build the project to a static web page like this:

pnpm run build

The static web page is output to the dist subdirectory.

Test the static web page

After building the static web page, you can test it locally using live-server.

First install live-server globally:

pnpm install -g live-server

Now change into the directory where the static web page is generated:

cd dist

From here, start live-server:

live-server

The web page should automatically be displayed in your browser.

Run automated tests

pnpm test

Environment variables

  • BASE_URL - Sets the URL for the connection to the backend.
  • GOOGLE_API_KEY - Sets to a valid Google API key to enable reverse geocoding of photo location in the browser.

Auth0 authentication details:

  • AUTH0_DOMAIN
  • AUTH0_CLIENT_ID
  • AUTH0_AUDIDENCE
  • AUTH0_ORIGIN