This is a starter template for Floe.

Getting Started

The following assumes you have already created a project in https://app.floe.dev.

1. Install dependencies

npm install
# or
yarn
# or
pnpm i

2. Set environment variables in .env.local

NEXT_PUBLIC_FLOE_API_KEY_ID=...
FLOE_API_KEY_SECRET=...

3. Run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000 with your browser to see the result.

4. (Optional) Configure a data source

This starter template comes with a sample .floe directory (in Floe this is known as a 'data source'). To use this data source in your template, you must add it to your project in the Floe dashboard.

Alternatively, you can add .floe directory in another repository and set that as your data source instead.

Learn More

Check out the docs to learn more about using Floe.

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.