> For the complete documentation index, see [llms.txt](https://ngxf.gitbook.io/platform/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ngxf.gitbook.io/platform/get-started/installation.md).

# Installation

## Installation

To get started, install the package from npm. The latest version (6.x) supports Angular/RX 6.

```bash
npm i @ngxf/platform @ngxf/socket.io socket.io-client @types/socket.io-client --save
​
# or if you are using yarn
yarn add @ngxf/platform @ngxf/socket.io socket.io-client @types/socket.io-client
```

then in `COMPONENT.module.ts`, import the `NgxfModule`:

```typescript
import { NgModule } from '@angular/core';
import { NgxfModule } from '@ngxf/platform';
import { NgxfSocketIOModule } from '@ngxf/socket.io';
​
@NgModule({
  imports: [
    NgxfModule,
    NgxfSocketIOModule
  ]
})
export class ComponentModule {}
```