/holon-gas

Gas tool for HOLON

Primary LanguageTypeScript

This is a Next.js project bootstrapped with create-next-app.

Getting Started

Copy the example environment file:

cp .env.example .env.local

Then, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Changing description texts

Most description texts in the model are written in Markdown and can be found in:

  • Help texts for sections: `data/help-texts.tsx~
  • Help texts for sliders and inputs: data/inputs.tsx
  • Tour texts: data/tour-texts.tsx

Changing inputs and sliders

Inputs are specified in data/inputs.tsx. This file contains the title and help texts, as well as the minimum, maximum, and default values.

  • value: The default starting value of the slider.
  • max: The maximum value of the slider.
  • min: The minimum value of the slider.
  • recommended: An optional value which will be drawn as a vertical "tick" line.
  • step: Controls how large the step size is. For example, the default step size of 1 allows a slider to have values 1, 2, 3, etc. while a step size of 0.1 allows 1.1, 1.2, 1.3, etc.
  • name: The human-readable name of the slider.
  • helpText: Optional text which will be shown if the user clicks the (?) icon next to the slider name.