mirror of
https://gitlab.nic.cz/turris/reforis/foris-js.git
synced 2024-12-25 00:11:36 +01:00
Foris JS library is a set of components and utils for reForis and plugins.
499be46588
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`. |
||
---|---|---|
docs | ||
scripts | ||
src | ||
translations | ||
.eslintignore | ||
.eslintrc.js | ||
.gitignore | ||
.gitlab-ci.yml | ||
.weblate | ||
babel.cfg | ||
babel.config.js | ||
CHANGELOG.md | ||
jest.config.js | ||
Makefile | ||
package-lock.json | ||
package.json | ||
prettier.config.js | ||
README.md | ||
requirements.txt | ||
styleguide.config.js |
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
- Crete a merge request to
dev
branch with version bumped - When merging add
[skip ci]
to commit message to prevent publishing unnecessary version - Create a merge request from
dev
tomaster
branch - 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:
- Setting
react-router-dom
aspeerDependencies
anddevDependencies
inpackage.json
. - Adding the following rules to
externals
inwebpack.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