FiftyOne App

The home of the FiftyOne App.

Installation

The following installation steps are a part of the install script.

First, install nvm and install and set your node version to v17.9.0 using nvm.

nvm install v17.9.0
nvm use v17.9.0

Then install yarn globally in your node environment with npm:

npm -g install yarn

Install the app with yarn in this directory:

yarn install

Development

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

yarn dev

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

python fiftyone/server/main.py

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

yarn dev:wpy

Either way, now simply launch the App like normal:

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.

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.

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