Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codatio/starter-project-nextjs-codat
Next.js starter with an example of fetching a list of companies from Codat
https://github.com/codatio/starter-project-nextjs-codat
codat nextjs starter
Last synced: 10 days ago
JSON representation
Next.js starter with an example of fetching a list of companies from Codat
- Host: GitHub
- URL: https://github.com/codatio/starter-project-nextjs-codat
- Owner: codatio
- Created: 2022-07-27T19:29:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-06T22:05:56.000Z (about 1 year ago)
- Last Synced: 2024-05-03T03:53:27.697Z (7 months ago)
- Topics: codat, nextjs, starter
- Language: JavaScript
- Homepage: https://starter-project-nextjs-codat.vercel.app/
- Size: 850 KB
- Stars: 3
- Watchers: 5
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# starter-project-nextjs-codat
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fcodatio%2Fstarter-project-nextjs-codat&env=CODAT_AUTH_HEADER&envDescription=Your%20Codat%20Auth%20Header&envLink=https%3A%2F%2Fdocs.codat.io%2Freference%2Fauthentication)
This project uses [Next 13 App Router](https://beta.nextjs.org/docs/getting-started) and Codat's new TypeScript SDK, which are both in Beta.
## Features
- Extends the [create-next-app](https://nextjs.org/docs/getting-started/installation) default
- Comes with our [TypeScript SDK](https://github.com/codatio/client-sdk-typescript)
- Add your API key and pull your companies
- Authorize companies with [Embedded Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)
- Auto-deploy to go live on Vercel instantly
---
## Getting started
This repo contains a Next.js project setup to work with [Codat](#what-is-codat).
### Running locally
```bash
git clone [email protected]:codatio/starter-project-nextjs-codat.git codat
cd codat
npm install
npm run dev
```
> You'll need your API key before making your first request!
> **[Getting your key...](https://docs.codat.io/reference/authentication).**
### Running on Vercel
Hit the **Deploy** above to clone the project and start building!
> You'll need your API key to initialize the project!
> **[Getting your key...](https://docs.codat.io/reference/authentication).**
## Next steps
### Learn more about Codat
- [Read our getting started guide for developers](https://docs.codat.io/docs/get-started-api)
- [Read how to get authenticated](https://docs.codat.io/reference/authentication)
- [Learn about our /companies endpoint](https://docs.codat.io/reference/listcompanies)
### Learn more about Next.js
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://beta.nextjs.org/docs/getting-started) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
## What is Codat?
Codat is the universal API for small business data. We provide real-time connectivity to enable software providers and financial institutions to build integrated products for their small business customers.
Small businesses run on many different platforms. Codat gives these platforms a standard way to connect with each other so they can move data around seamlessly at scale.
---
If you've got feedback on this sample project or have ideas for other sample projects you'd like to see, raise an [Issue](https://github.com/codatio/starter-project-nextjs-codat/issues) or [drop us an email](mailto:[email protected]).