# @fiftyone511/fiftyone

> The home of the [FiftyOne App](https://voxel51.com/docs/fiftyone/user_guide/app.html).

Latest version **0.1.0** (published 2022-08-18) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @fiftyone511/fiftyone
pnpm add @fiftyone511/fiftyone
yarn add @fiftyone511/fiftyone
bun add @fiftyone511/fiftyone
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2022-08-18 |
| First published | 2022-08-18 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| Maintainers | fiftyone511 |

## Links

- npm: https://www.npmjs.com/package/@fiftyone511/fiftyone
- npm.io page: https://npm.io/package/@fiftyone511/fiftyone

## Recent versions

- 0.1.0 (latest) — 2022-08-18

## README

# FiftyOne App

The home of the
[FiftyOne App](https://voxel51.com/docs/fiftyone/user_guide/app.html).

## Installation

The following installation steps are a part of the
[install script](../install.bash).

First, install [`nvm`](https://github.com/nvm-sh/nvm) and install and set your
node version to `v17.9.0` using `nvm`.

```sh
nvm install v17.9.0
nvm use v17.9.0
```

Then install `yarn` globally in your node environment with `npm`:

```shell
npm -g install yarn
```

Install the app with `yarn` in this directory:

```shell
yarn install
```

## Development

First, start the App client development server with hot reloading by running:

```shell
yarn dev
```

Next, we generally recommend starting the backend server manually so you have
access to stack traces:

```shell
python fiftyone/server/main.py
```

If you want to run both the app client development server and the backend
server, try running:

```shell
yarn dev:wpy
```

Either way, now simply launch the App like normal:

```py
import fiftyone as fo
import fiftyone.zoo as foz

dataset = foz.load_zoo_dataset("quickstart")

session = fo.launch_app(dataset)
```

## Style Guide

All App code contributed to FiftyOne must follow our
[style guide](../STYLE_GUIDE.md#app-style-guide).

## Best practices

This section will continue to evolve as we learn more about what works best.

It should be noted that this App was began as this
[boilerplate](https://github.com/electron-react-boilerplate/electron-react-boilerplate).

Best practices:

-   All React components should be function-based, not class-based
-   We recommend writing fully typed TypeScript, although we are still
    transitioning
-   With the app dev environment installed, you can run `yarn storybook`

---
_Source: https://npm.io/package/@fiftyone511/fiftyone · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._