GGLinnk/foris-js
1
0
Fork 0
mirror of https://gitlab.nic.cz/turris/reforis/foris-js.git synced 2024-11-14 17:35:35 +01:00
Code Issues Releases Activity
Foris JS library is a set of components and utils for reForis and plugins.
585 Commits 9 Branches 64 Tags 17 MiB
JavaScript 97.2%
Makefile 1.5%
CSS 0.8%
Shell 0.5%
bb5177e858
Go to file
Stepan Henek bb5177e858
Using socket.io for websocket handling and make reforis configurable 
Socket.io wrapper is used to handle websockets now,
this means that websocket logic had to be redone.

Also it is necessary to set `REFORIS_PREFIX` env variable
during the build process. To set the path of backend url.
It was previously fixed to `/reforis`.
2023-01-31 11:15:52 +01:00
docs Improve docs development section 2022-09-16 16:10:44 +02:00
scripts Fix access token in publish script 2022-02-28 16:47:52 +01:00
src Using socket.io for websocket handling and make reforis configurable 2023-01-31 11:15:52 +01:00
translations Translated using Weblate (Russian) 2022-12-07 13:47:07 +01:00
.eslintignore Extract the library from reforis. 2019-08-21 17:04:26 +02:00
.eslintrc.js Integrate Prettier + ESLint + reForis Style Guide 2020-08-18 16:17:00 +02:00
.gitignore Remove testUtils from .gitignore 2022-12-22 15:35:21 +01:00
.gitlab-ci.yml gitlab-ci: Update Node.js image to v16 2022-02-22 16:38:19 +01:00
.prettierrc Integrate Prettier + ESLint + reForis Style Guide 2020-08-18 16:17:00 +02:00
.weblate Add weblate config file. 2020-02-20 17:19:07 +01:00
babel.cfg Updated translation messages after moving WiFi form. 2020-01-13 16:10:19 +01:00
babel.config.js Format all files with Prettier 2020-08-18 16:17:00 +02:00
jest.config.js Format all files with Prettier 2020-08-18 16:17:00 +02:00
Makefile Makefile: Fix spelling mistakes in echo statements 2022-02-22 16:38:10 +01:00
package-lock.json Using socket.io for websocket handling and make reforis configurable 2023-01-31 11:15:52 +01:00
package.json Using socket.io for websocket handling and make reforis configurable 2023-01-31 11:15:52 +01:00
README.md Format all files with Prettier 2020-08-18 16:17:00 +02:00
requirements.txt Added virtual environment and packages required for translations. 2019-11-14 11:28:28 +01:00
styleguide.config.js Move contexts in a context folder 2022-12-22 15:35:22 +01:00

README.md

foris-js

Set of utils and common React elements for reForis.

Publishing package

Beta versions

Each commit to dev branch will result in publishing a new version of library tagged beta. Versions names are based on commit SHA, e.g. foris@0.1.0-beta.d9073aa4.

Preparing a release

  1. Crete a merge request to dev branch with version bumped
  2. When merging add [skip ci] to commit message to prevent publishing unnecessary version
  3. Create a merge request from dev to master branch
  4. New version should be published automatically

Manually managed dependencies

Because of <ForisForm /> component it's required to use exposed ReactRouterDOM object from react-router-dom library. ReactRouterDOM is exposed by reForis. It can be done by following steps:

  1. Setting react-router-dom as peerDependencies and devDependencies in package.json.
  2. Adding the following rules to externals in webpack.conf.js of the plugin:
externals: {
    ...
    "react-router-dom": "ReactRouterDOM",
}

Docs

Build or watch docs to get more info about library:

make docs

or

make docs-watch