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.
666 Commits 9 Branches 64 Tags 17 MiB
JavaScript 97.2%
Makefile 1.5%
CSS 0.8%
Shell 0.5%
499be46588
Go to file
Aleksandr Gumroian 499be46588
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`.
2024-09-05 13:02:13 +02: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 2024-09-05 13:02:13 +02:00
translations Translated using Weblate (Spanish) 2024-08-24 15:09:22 +02:00
.eslintignore Extract the library from reforis. 2019-08-21 17:04:26 +02:00
.eslintrc.js Fix linting issues 2024-06-10 16:28:25 +02:00
.gitignore Remove testUtils from .gitignore 2022-12-22 15:35:21 +01:00
.gitlab-ci.yml gitlab-ci: Use custom reforis-image 2024-01-19 21:15:50 +03: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
CHANGELOG.md Bump v6.1.1 2024-08-30 15:56:08 +02:00
jest.config.js Update Snapshots 2024-06-10 16:28:24 +02:00
Makefile Add JS_DIR variable to Makefile 2024-04-29 15:19:20 +02:00
package-lock.json Using socket.io for websocket handling and make reforis configurable 2024-09-05 13:02:13 +02:00
package.json Using socket.io for websocket handling and make reforis configurable 2024-09-05 13:02:13 +02:00
prettier.config.js Fix linting issues 2024-06-10 16:28:25 +02: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 Update Snapshots 2024-06-10 16:28:24 +02: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