Giter VIP home page Giter VIP logo

swg-map-viewer's Introduction

Star Wars Galaxies Map Viewer

A Map Viewer for Star Wars Galaxies. Uses Leaflet to allow the original Planets from Galaxies to be richly annotated with waypoints, markers and other content.

The Planet Selection screen is powered by ThreeJS, and react-three-fiber.

UI Elements are powered by Material UI.

Development

To bootstrap the project, you'll need a recent version of Node & Yarn v1 installed.

To install Node dependencies, simply run yarn.

You'll also need the following non-Node dependencies:

  • gdal2tiles-leaflet should be cloned within a sibling directory, and any of it's dependencies installed on your machine.
    • This is used to split the source planet maps into tiled versions
    • Will also require python3 to be available within your PATH.
  • pngquant to be installed on your machine.
    • Used to compress output tiles to reduce bandwidth requirements by up to 70%. Tile compression can be disabled with by using DISABLE_OPTIMIZATION=true yarn generate-tiles

When all dependencies are installed, you can run the following commands in the project folder:

yarn generate-tiles

Generate (or regenerate) the tileset used by the application. This command may take a long time to complete (Typically around 3~5 minutes).

As above, this process requires python3, gdal2tiles-leaflet, and pngquant.

By default, tiles will be compressed using pngquant to save bandwidth when hosting the application in a production environment. If you do not desire this behaviour, simply use DISABLE_OPTIMIZATION=true yarn generate-tiles.

yarn start

Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console, and any build errors will occupy a full screen error window.

yarn build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

See the create-react-app docs about deployment for more information.

swg-map-viewer's People

Contributors

dependabot[bot] avatar geit avatar renovate-bot avatar renovate[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

swg-map-viewer's Issues

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined. Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Warning

These dependencies are deprecated:

Datasource Name Replacement PR?
npm @types/rimraf Unavailable
npm drei Unavailable

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

  • fix(deps): update dependency @react-three/drei to v9.108.1
  • chore(deps): lock file maintenance

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions
.github/workflows/check-pr.yml
  • actions/checkout v4
  • actions/setup-node v4
.github/workflows/deploy-master.yml
  • actions/checkout v4
  • actions/setup-node v4
  • burnett01/rsync-deployments 5.2
npm
package.json
  • @babel/eslint-parser ^7.22.5
  • @typescript-eslint/eslint-plugin 7.14.1
  • @typescript-eslint/parser 7.14.1
  • eslint 8.57.0
  • eslint-config-prettier 9.1.0
  • eslint-plugin-eslint-comments 3.2.0
  • eslint-plugin-import 2.29.1
  • eslint-plugin-prettier 5.1.3
  • eslint-plugin-promise 6.2.0
  • eslint-plugin-react 7.34.3
  • eslint-plugin-react-hooks 4.6.2
  • prettier 3.3.2
  • rimraf 5.0.7
  • ts-node 10.9.2
  • typescript 5.5.2
packages/frontend/package.json
  • @emotion/react ^11.11.1
  • @emotion/styled ^11.11.0
  • @juggle/resize-observer 3.4.0
  • @mui/material ^5.13.6
  • @mui/styles ^5.13.2
  • @mui/x-tree-view ^6.17.0
  • @react-three/drei 9.107.3
  • @react-three/fiber 8.16.8
  • drei 2.2.21
  • leaflet 1.9.4
  • lodash 4.17.21
  • react 18.3.1
  • react-copy-to-clipboard 5.1.0
  • react-dom 18.3.1
  • react-leaflet ^4.2.1
  • react-router-dom 6.24.0
  • react-use-measure 2.1.1
  • recoil 0.7.7
  • three 0.166.0
  • vite-plugin-svgr ^4.0.0
  • @svgr/parcel-plugin-svgr 5.5.0
  • @types/leaflet ^1.9.3
  • @types/lodash ^4.14.195
  • @types/node ^20.3.2
  • @types/react ^18.2.14
  • @types/react-copy-to-clipboard ^5.0.1
  • @types/react-dom ^18.2.6
  • @types/rimraf ^4.0.5
  • @types/three ^0.166.0
  • @vitejs/plugin-react ^4.0.1
  • sass 1.77.6
  • vite ^5.0.0

  • Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.