> For the complete documentation index, see [llms.txt](https://ferp.mrbarry.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ferp.mrbarry.com/getting-started/install.md).

# Installing Ferp in Your Application

## Installing

Depending on your project, needs, and target audience, there are a number of ways to get up and running with Ferp within seconds.

### Installing from npm or yarn

You know the drill!

```bash
npm install --save ferp@^2
# OR
yarn add ferp@^2
```

And import Ferp into your code-base:

{% tabs %}
{% tab title="From es6/babel" %}

```javascript
import { app, effects } from 'ferp';
```

{% endtab %}

{% tab title="From NodeJS" %}
{% code title="index.js" %}

```javascript
const { app, effects } = require('ferp');
```

{% endcode %}
{% endtab %}
{% endtabs %}

If you are targeting a web browser, you may need to bundle or build your scripts, with something like [rollup](https://rollupjs.org/), [webpack](https://webpack.js.org/), or [parcel](https://parceljs.org/).

### Using a CDN

Of course, you don't need to install anything at all. Content delivery networks (CDNs) like unpkg work great!

{% tabs %}
{% tab title="Standard es5 javascript" %}
{% code title="index.html" %}

```markup
<script src="https://unpkg.com/ferp@2"></script>
```

{% endcode %}

```bash
const { app, effects } = window.ferp;
```

{% endtab %}

{% tab title="Modern Browsers" %}

```markup
<script type="module">
  import { app, effects, util } from 'https://unpkg.com/ferp?module=1';
</script>
```

{% endtab %}
{% endtabs %}

With a CDN, there is no install needed to get going. Of course, you may want to look into [Service Workers](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API/Using_Service_Workers) if you want to support your application while offline.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://ferp.mrbarry.com/getting-started/install.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.