mirror of
https://gitlab.nic.cz/turris/reforis/foris-js.git
synced 2025-04-25 08:46:39 +02:00
39 lines
980 B
Markdown
39 lines
980 B
Markdown
Welcome to the official Foris JS documentation!
|
|
|
|
## About Foris JS
|
|
|
|
Foris JS is a library containing reusable components and utilities designed
|
|
specifically for the reForis application and its plugins.
|
|
|
|
**Note:** All components and utilities in this library are actively used in
|
|
reForis and its plugins. To see practical examples of how they're implemented,
|
|
we recommend searching through those repositories.
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
Before installing, ensure you have [Node.js](https://nodejs.org/en/) installed
|
|
on your system.
|
|
|
|
We recommend using the current Long Term Support (LTS) version for optimal
|
|
compatibility. Check the
|
|
[release schedule](https://github.com/nodejs/Release#release-schedule) for
|
|
details.
|
|
|
|
### Installation
|
|
|
|
Install the latest version with:
|
|
|
|
```bash
|
|
npm install foris
|
|
```
|
|
|
|
Or install a specific version by running:
|
|
|
|
```bash
|
|
npm install foris@version
|
|
```
|
|
|
|
[](https://badge.fury.io/js/foris)
|