Skip to content

dons20/steam-review-editor

Repository files navigation

Steam Review Editor

Introduction

Steam Review Editor is a simple but useful utility to help curators write, format and preview their reviews before they publish them officially. It shows you at a glance, the formatting options that Steam support on their platform, allowing you to be extra creative when writing, instead of trying to memorize complex syntax.

This tool can also be helpful outside of the review section. Anywhere that the Steam markup is allowed, you can use the markup generated by the editor to help to customize your text.

This means you can use it to format some aspects of your profile, guides, and even your Steam workshop descriptions.

How to test locally

Be sure to have Node v24 LTS or higher on your development machine.

  1. Clone or download the source code in the main branch
  2. Open a terminal inside the cloned directory.
  3. Type pnpm install to install the dependencies.
  4. Type pnpm start to start a local development server.
  5. Type pnpm run build to build the files for production.

E2E Testing

The project includes a standalone Playwright suite for end-to-end editor coverage.

  1. Run pnpm test:e2e:install once to install the Chromium browser used by the suite.
  2. Run pnpm test:e2e to execute the full E2E suite.
  3. Run pnpm test:e2e:headed for headed browser debugging.
  4. Run pnpm test:e2e:ui to use the Playwright UI runner.

The suite is intentionally organized so spec files only contain direct test scenarios, while shared selectors and interaction flows live in e2e/helpers.

Resources

  • The main editor is built with TipTap
  • Icons sourced from Lucide React
  • Inspiration for colours, layout, and overall design were sourced from the Steam web store: Steam Store

Contribution Guidelines

Thank you for considering contributing to this project!

  • Fork the repository and create your branch from main.
  • Ensure your code adheres to the existing style and conventions.
  • Write clear and concise commit messages.
  • Submit a pull request with a detailed description of your changes.

License

This application is licensed under the MIT License.

Attribution

Respository Image / Social Preview - Designed by slidesgo / Freepik

About

Easily create, format and preview your Steam reviews in real-time

Topics

Resources

License

Stars

Watchers

Forks

Contributors