VGDC

This is the repo for the VGDC website.

What was used

• Framework: React 19
• Bundler: Vite
• Mapping & Visualization:
  • Deck.gl (Core, Layers, React)
  • Google Maps (via @vis.gl/react-google-maps)
  • Mapbox GL (via react-map-gl)
• Routing: React Router
• Styling: Sass (SCSS)
• State Management: @plq/use-persisted-state for persistent state
• Linting: ESLint

---

Prerequisites

Before you begin, ensure you have Node.js installed on your system.

• Node.js: This project requires version >=22.12.0 as specified in package.json.

---

Available Scripts

This project comes with several pre-configured npm scripts:

npm run dev

Runs the application in development mode with hot-reloading. The server is configured to be accessible from your local network (it listens on 0.0.0.0).

npm run build

Builds the application for production. This script bundles your code and optimizes it, outputting the static files to the dist directory.

npm run preview

Starts a local static web server that serves the production-built files from the dist directory. This is useful for verifying that the production build works correctly before deploying.

npm run lint

Runs the ESLint linter across the project to check for code quality and style issues, based on the rules in eslint.config.js.

---

Server Configuration

The Vite configuration (vite.config.js) is set up to allow access from specific domains and IP addresses for both the development and preview servers. This is intended for deployment on a server, such as an AWS EC2 instance.

The provided start.sh script suggests a deployment flow of pulling from Git, installing dependencies, building the project, and running the development server. For a production deployment, you would typically use npm run preview or a dedicated static file server.