Getting Started

Create RADFish App is the officially supported tool for creating single-page React applications. It offers a modern build setup with no configuration.

Prerequisites

Before you start, make sure you have the following installed:

• Node.js (v20.17.0 or later)
• npm (v10.8.2 or later)
• git (v2.0 or later)

Quick Start

Option 1: Scaffold a new app from a template

Start your app with a barebones and pre-configured template.

npx @nmfs-radfish/create-radfish-app my-app
cd my-app
npm start

Once the development server starts, visit http://localhost:3000/ in your browser to see your app.

Option 2: Scaffold a new app from an example

Select an example and run the command using the --example tag.

npx @nmfs-radfish/create-radfish-app my-app --example multistep-form
cd my-app
npm start

Option 3: Clone the boilerplate repository to access all examples

To get all the examples, clone the boilerplate repository:

git clone https://github.com/NMFS-RADFish/boilerplate.git

Then navigate to the example you want to run and start the app:

cd boilerplate/examples/[example you want to run]
npm install
npm start

Once the development server starts, visit http://localhost:3000/ in your browser to see your app.

Using the help flag

The --help flag is a common option that displays helpful information about a command or script, including available options and usage instructions.

npx @nmfs-radfish/create-radfish-app --help

Upgrading package versions in your app

1. In the root of your project run:

   npm update

2. Check for Changes:

   npm test

Please visit upgrading for more information.

Scripts

npm start

This script starts the Vite development server. It runs the app locally with hot module reloading, allowing for fast development and instant updates as you make changes. Open http://localhost:3000 to view it in the browser.

See Available Scripts for full list of commands.

Next steps

Now that you are up and running, see the Components & Usage section to start building out your first pages!