remark42/frontend/apps/remark42

title

title
Frontend Development Guidelines

Prerequisites

Frontend for Remark42 is built with Preact and Redux.

::: note 💡 We highly recommend checking out Preact documentation. TLDR: Preact replicates React API and compatible with its libraries. :::

In order to inject Remark42 widgets into websites we use iframe and postMessage for communication between a site and the widget. Simple widgets like counter widget can be injected as a script because it doesn't have its own interface.

While developing, we set up environment which imitates real world example. We serve the page which uses Remark42 config and inject all the widgets on it. You can check it on our demo site. After successful installation you should have the same page running locally.

Installation

You must have at least 2GB RAM or swap enabled for building.

• install Node.js 16 or higher (we recommend using NVM for node version autoswitch)
• install PNPM 8
• run pnpm i inside ./frontend

Running pnpm i will set up pre-commit hooks into your git repository. They are used to reformat your frontend code using prettier and lint with eslint and stylelint before every commit.

::: note 🚨 Please use 127.0.0.1 and not localhost to access the server; otherwise, CORS will prevent your browser from authentication to work correctly. You could alter the address for dev auth with the REMARK_URL environment variable. :::

Development

Run frontend with remote backend

You can run frontend against demo instance of Remark42. This method of running Remark42 frontend code is preferred when you make a translation or visual adjustments that are easy to see without extensive testing. For this method we use our demo instance of Remark42 served on https://demo.remark42.com

For local development mode with Hot Reloading, use pnpm dev:app. In this case, webpack will serve files using webpack-dev-server on 127.0.0.1:9000. By visiting http://127.0.0.1:9000/web/, you will get a page with the main comments' widget communicating with a demo server backend running on https://demo.remark42.com. But you will not be able to log in with any OAuth providers due to security reasons.

You can attach the frontend to the locally running backend from frontend/apps/remark42 folder and providing the REMARK_URL environment variable.

npx cross-env REMARK_URL=http://127.0.0.1:8080 pnpm dev:custom

::: note ℹ️ If you want to redefine env variables such as PORT on your local instance, you can add the .env file to the ./frontend folder and rewrite variables as you wish. For such functional, we use dotenv. :::

Run frontend with backend locally

This option of running Remark42 frontend code is preferred when you need extensive testing of your code changes, as you'll have your backend and configure it as you want, for example, enable any auth and notifications method you need to test. You can use that set up to develop and test both frontend and backend.

To bring the backend up, run:

cp compose-dev-frontend.yml compose-private.yml
# now, edit / debug `compose-private.yml` to your heart's content

# build and run
docker compose -f compose-private.yml up --build

Then in the new terminal tab or window, run the following to start the frontend with Hot Reloading:

cd frontend
pnpm dev:app

Developer build running by webpack-dev-server supports devtools for React and Redux.

It starts Remark42 backend on 127.0.0.1:8080 and adds local OAuth2 provider "Dev". To access the frontend running by Node, go to http://127.0.0.1:9000/web/. By default, you would be logged in as dev_user, defined as admin. You can tweak any of the supported parameters in corresponded yml file.

Manual testing after changes

Frontend Docker Compose config (compose-dev-frontend.yml) by default skips running backend related tests.

::: note 🚨 Before submitting your changes as a Pull Request, run the backend using the docker compose -f compose-dev-frontend.yml build --build-arg SKIP_FRONTEND_BUILD=""; docker compose -f compose-private.yml up command and test your changes against http://127.0.0.1:8080/web/, frontend, built statically (unlike frontend on port 9000, which runs dynamically). That is how Remark42 authors will test your changes once you submit them. :::

Static build

Remark42 frontend can be built statically, and that's how the production version works: frontend is built and then resulting files embedded into the backend, which serves them as-is. Node is not running when a user starts Remark42, only the backend written in Go programming language, which also serves pre-built frontend HTML and JS and CSS files.

Run pnpm build inside ./frontend, and result files will be saved in ./frontend/apps/remark42/public.

Code Style

• The project uses TypeScript to analyze code statically
• The project uses Eslint and Stylelint to check the frontend code. You can manually run via pnpm lint
• Git Hooks (via husky) installed automatically on pnpm i. They check and try to fix code style if possible, otherwise commit will be rejected
• If you want IDE integration, you need Eslint and Stylelint plugins to be installed. Also, you have configured Eslint for work in subdirectory. For example, you have to add configuration for VSCode like that "eslint.workingDirectories": ["frontend/apps/remark42"]

CSS Styles

• Now we are migrating to CSS Modules, which is a recommended way of stylization. A file with styles should be named like component.module.css
• Old component styles use BEM notation (at least it should): block__element_modifier. Also, there are mix classes: block_modifier
• The new way to name CSS selectors is camel-case like blockElemenModifier and use clsx to combine it
• Component base style resides in the component's root directory with a name of component converted to kebab-case. For example, ListComments style is located in ./app/components/list-comments/list-component.tsx
• Any other files should also be named in kebab-case. For example, ./app/utils/get-param.ts

Imports

• Imports for TypeScript, JavaScript files should be without extension: ./index, not ./index.ts
• If the file resides in the same directory or subdirectory, the import should be relative: ./types/something
• Otherwise, it should be imported by absolute path relative to src folder like common/store which mapped to ./app/common/store.ts in webpack, tsconfig, and Jest

Testing

• Project uses Jest as test framework
• Testing Library is used as UI test utilities (there are still tests with Enzyme, but we are in process of migration)
• Jest checks files that match regex \.(test|spec)\.ts(x?)$, i.e., comment.test.tsx, comment.spec.ts
• Tests are running on push attempt
• Example tests can be found in ./app/components/auth/auth.spec.ts, ./app/store/user/reducers.test.ts

Notes

Frontend part being bundled on docker env gets placed on /src/web and is available via http://{host}/web. For example, embed.mjs entry point will be available at http://{host}/web/embed.mjs

Learn More

• How to Add a New Locale
• Remark42 Instance Parameters