websustainability.io

In October 2023, the W3C Community published the first draft of the Web Sustainability Guidelines (WSG). This tool is an independent side project that offers a way to navigate and prioritize these guidelines. For the implementation we use TypeScript and React. Feel free to suggest features, report bugs or contribute!

System requirements

• Node
• Yarn

The .nvmrc file in project root describes what Node version to use to make sure we all use the same. To switch between Node versions, a version manager, such as Node Version Manager (NVM), is a helpful tool.

Run app in development mode

# Install dependencies
yarn install

# Run app
yarn dev

Now you can navigate to the following URL: http://localhost:5173/

Run app in production mode

# Install dependencies
yarn install

# Build app for production
yarn build

# Test run app
yarn preview

Now you can navigate to the following URL: http://localhost:4173/

Deployment

App is auto deployed when changes are pushed to branch main. We use Digital Ocean for hosting.

Code style

We use ESLint to find issues in the code. You can setup your code editor to highlight such issues, based on the project config. There is also an option to run the following command from terminal:

# Run linter
yarn lint