Starter Project Nextjs Codat is a boilerplate Next.js 13 template for developers who want to build an application that fetches company data from Codat, the universal API for small business data. The template demonstrates how to connect a Next.js frontend to Codat's /companies endpoint using the official TypeScript SDK, and it ships with a one-click Vercel deployment option.
What is Starter Project Nextjs Codat?
Starter Project Nextjs Codat is an open-source starter repository maintained by Codat that pairs Next.js 13's App Router with Codat's TypeScript SDK. It takes a Codat API key as input and produces a working web app that lists companies from your Codat workspace. The project extends the default create-next-app scaffold, so it runs on any Node.js environment and can be deployed instantly to Vercel.
Key Features
- Next.js 13 App Router — Uses the beta App Router from Next.js, with file-based routing and server components.
- Codat TypeScript SDK — Includes the official Codat client SDK for TypeScript, pre-wired to make authenticated requests.
- Company listing example — Demonstrates fetching companies from the /companies endpoint after you add your API key.
- Codat Embedded Link SDK — Shows how to authorize companies with Codat's Embedded Link authorization flow.
- Vercel auto-deploy — A Deploy with Vercel button clones the repository, sets the CODAT_AUTH_HEADER environment variable, and publishes the app.
- Local development setup — Clone, npm install, and npm run dev bring the app up on the default Next.js development server.
Who is it for?
Starter Project Nextjs Codat is built for software providers and financial institutions that need to integrate small business data into their products. Developers at these organizations can use the template to see a working end-to-end example of Codat integration before building their own features. It is also useful for Next.js developers who want to learn how to call Codat's API from a server-rendered React app.
What can you do with Starter Project Nextjs Codat?
- Software providers: Pull a list of companies from Codat to display in your dashboard or product UI.
- Financial institutions: Combine the company listing with Codat's Embedded Link flow to let your small business customers authorize data connections.
- Next.js developers: Study the project as a reference for structuring a Next.js 13 App Router application with a third-party TypeScript SDK.
How does it work?
Clone the repository, run npm install and npm run dev, then add your Codat API key. The project's example page calls the /companies endpoint through the TypeScript SDK and renders the returned list. For production, use the Vercel deploy button and supply the CODAT_AUTH_HEADER environment variable when prompted.
