Quick Start

Want to get started quickly with React. We got you.

Requirements

Reactium requires a minimum of Node 18 LTS (Recommended), and supports up to Node 20.

Create a starter React app

Before we get into the multitude of pieces and uses of the whole platform, let's get into the easiest and fastest way to get started. If you just want to feel the instant power of the first major and important piece of the platform you can get up and going very quickly with the Reactium App Foundation.

• Install git and Node.js

• Create a new application in the directory of your choice

mkdir my-app # whatever you want
cd my-app
npx reactium init

To just use reactium instead of npx reactium, install it globally with: npm install -g reactium

reactium init can create Web or API projects

Great! Now you've got Reactium installed!

Running Locally

Much like other popular React application creators, Reactium already has a lot of the local development environment taken care of. With a single npm script, you'll be compiling modern React javascript and Sassy CSS into a routable Node/Express application.

npm run local

If you did everything correctly, you will see the reactium.io website appear in an iframe.

Remove Welcome Component

Before we go further, let's remove the Welcome React component.

rm -rf src/app/components/Welcome # or remove from the GUI

Now the root of route should just be a blank page.

The Development Server

By default, the node/express server will listen on port 3030 and 3000 (Express and BrowserSync respectively). Your default browser should automatically open to http://localhost:3000 for you.

Your First Routed Hello World Component

You can manually create React components in your project, but Reactium can also help you with some common boilerplate. Let's create a simple hello world component for our homepage:

npx reactium component

Easily set a route for a new component.

Prerequisites

This page assumes you are have some familiarity with:

• Node.js and React

• npm (node package manager)