https://github.com/lwjgl/lwjgl3-www
The LWJGL 3 website.
https://github.com/lwjgl/lwjgl3-www
babel lwjgl react stitches typescript webpack
Last synced: 12 months ago
JSON representation
The LWJGL 3 website.
- Host: GitHub
- URL: https://github.com/lwjgl/lwjgl3-www
- Owner: LWJGL
- License: bsd-3-clause
- Created: 2014-11-20T23:02:42.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2024-04-03T10:08:16.000Z (over 2 years ago)
- Last Synced: 2024-04-03T11:27:14.443Z (over 2 years ago)
- Topics: babel, lwjgl, react, stitches, typescript, webpack
- Language: TypeScript
- Homepage: https://www.lwjgl.org
- Size: 13.3 MB
- Stars: 104
- Watchers: 13
- Forks: 22
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [lwjgl.org](https://www.lwjgl.org) - Home of Lightweight Java Game Library
The website for LWJGL is build with React. It is a single-page application with client-side routing. It installs a Service Worker in order to work offline.
### Notable features:
- Client-side [routing](https://github.com/ReactTraining/react-router)
- Service Worker (works offline)
- Tiny production build (entire codebase + content weights less than 300KB gzipped)
- Code splitting at route & component level
- Scroll restoration
- Route preloading
- Proximity based route preloading (see /download page)
- Build Customizer with smart download queue & client-side ZIP generator
- Custom [webpack](http://webpack.js.org/) manifest parsing + code minification
- CSS-in-JS with [Stitches](https://stitches.dev/)
- Client is written in [Typescript](https://www.typescriptlang.org/)
### Warning:
There is currently no server-side rendering because of hosting constraints.
## Dependencies
Static assets are loaded from LWJGL's CDN ([AWS CloudFront](https://aws.amazon.com/cloudfront/)).
Build status icons are loaded directly from [travis-ci.org](https://travis-ci.org/) and [appveyor.com](https://www.appveyor.com/).
[Three.js](https://threejs.org/) is loaded from [jsDelivr](https://www.jsdelivr.com/).
## Prerequisites
- [Node.js v22+](https://nodejs.org/)
- [PNPM](https://pnpm.io/)
## Development
Install all required npm packages and build styles:
```shell
#corepack enable
pnpm i
node --run build:styles
```
Start the server in dev mode:
```shell
node --run start
```
### CLI flags
The following flags are used for testing production builds locally.
NODE_ENV environment variable must be set to "production".
```shell
--test # Enables production test mode (e.g. disables HSTS)
--nocache # Disables Pug view caching
--pretty # Pretty prints HTML
--s3proxy # Proxies S3 images
```
### Environment variables
```shell
NODE_ENV="production" # default: development
PORT="8080" # default: 80
HOST="127.0.0.1" # default: 0.0.0.0
```
### Codebase Diagram
[Visualization of the codebase](https://octo-repo-visualization.vercel.app/?repo=LWJGL%2Flwjgl3-www)
## Production
To deploy LWJGL in production please read the separate guide: [DEPLOYMENT.md](./DEPLOYMENT.md).
### Testing production builds
```shell
git pull
pnpm i
node --run release
```
You can run the production build locally:
```shell
node --run dev:test-production
```
### Debugging production output
The following debugging tips may come in handy:
- Disable minification by uncommenting `minimize: false` in [webpack.config.js](./webpack.config.js)
- Prevent Terser from dropping `console.log` or `debugger` by changing `terserOptions` in [terser-config.json](./scripts/terser-config.json)
- Set `PROFILING=1` env variable to load React profiling builds
- Output `named` module & chunk ids in [webpack.config.js](./webpack.config.js)
- Analyze build output with `npx webpack-bundle-analyzer public/js/build.manifest.json -h 0.0.0.0` (for full breakdown, change to `all: true` when writing `build.manifest.json` in [build-production.js](./scripts/build-production.mjs))
## Other LWJGL subdomains:
- The website for LWJGL 2 can be found [here](https://github.com/LWJGL/lwjgl-www). A static copy of the old LWJGL website is now hosted directly from S3
- The blog is powered by [Ghost](https://ghost.org/).
- The forum is [SMF](https://simplemachines.org/).
- The wiki for LWJGL 2 was [MediaWiki](https://www.mediawiki.org/). A static copy of the old LWJGL wiki is now hosted directly from S3.