Skip to content

sutrolabs/census-embedded-demo

Repository files navigation

This project showcases how to embed Census Reverse ETL in a Next.js web app.

Main features:

  • Developer authentication via Personal Access Token
  • Use Census Connect to have users authorize access to destinations
  • Create, edit, and monitor syncs via API

Docs

For more details on how to use Census Embedded, please refer to the main documentation:

https://developers.getcensus.com/embedded/overview

Local development

To run this project locally, you will need to download and install Node.js.

Initialize the project dependencies with...

npm install

By default this is pointed at Census production, but you can alter the CENSUS_BASE_URL env variable to point to another Census environment. See .env.local.example if you want to use a .env.local.

...and then you can start up the web service with...

npm run dev

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

Deploy to Netlify

This project also supports deploying to Netlify.

If you just want to deploy right away, you can click this button:

Deploy to Netlify Button

Alternatively, you can install and set up the Netlify project via CLI:

npm install -g netlify-cli

netlify init

Then you can use netlify deploy to manually deploy and netlify open to open your project dashboard.