Quick Start

Oblong is a React based framework. If you have an existing project, you can skip to Installation. Otherwise the first step of creating an Oblong app is to create a React app.

Create a React App

Oblong doesn't maintain any project templates or starter packages. Instead, it relies on the wealth of existing options for React.

Whichever path you choose, it is highly encouraged (seriously, probably consider it mandatory) to use TypeScript!

• Create React App is a popular and featureful option, use the --template typescript option
• Vite is making waves for being very fast, use the react-ts template
• Snowpack is similar to Vite
• From scratch if you need ultimate control

Installation

After you have a working React application, you can install Oblong which brings along all other necessary dependencies.

# If you're using NPM

npm i oblong

# Or yarn

yarn add oblong

Setup

createOblongApp will create a component to wrap your application:

import { createOblongApp } from 'oblong'

const OblongApp = createOblongApp()

export const App = () => <OblongApp>Your application here</OblongApp>

// The following line might be required if your setup expects a default export

export default App