Skip to content

This repository is dedicated to generating dummy data and a sample dashboard that mirrors a company that manages digital document signatures in real-time.

License

Notifications You must be signed in to change notification settings

tinybirdco/signatures-POC

Repository files navigation

Slack Status

Signatures POC

This repository is dedicated to generating dummy data and a sample dashboard that mirrors a company that manages digital document signatures in real-time. This tool is particularly useful for testing and development purposes.

screenshot of Signatures Dashboard

Setup

Requirements

  • Node.js < v. 18
  • Python < v. 3.8
  1. Setup your Tinybird account

Click this button to deploy the data project to Tinybird 👇

Deploy to Tinybird

Follow the guided process, and your Tinybird workspace is now ready to start receiving events.

  1. Setup this repository locally
git clone https://github.com/tinybirdco/signatures-POC.git
cd signatures-POC
  1. Install dependencies
npm install
  1. Setup Tinybird CLI

The install script above will automatically install and configure the tinybird-cli for this project.

Choose your region: 1 for us-east, 2 for eu. A new .tinyb file will be created.tb

Go to https://ui.tinybird.co/tokens and copy the token with admin rights.

⚠️Warning! The Admin token, the one you copied following this guide, is your admin token. Don't share it or publish it in your application. You can manage your tokens via API or using the Auth Tokens section in the UI. More detailed info at Auth Tokens management

This script will also push the data project to your Tinybird workspace.

  1. Start generating data!

In the terminal, run the following command:

npm run seed

Go to your Tinybird workspace and check the data is flowing.

  1. Setup the organizations materialized view

Go to the all_unique_organizations pipe in your Tinybird workspace and click the dropdown carrot button next to "Create API Endpoint, and select "Create Materialized View". This will create the organizations materialized view data source in your workspace.

image

  1. Copy the environment variables to .env

Locally, be sure to paste the admin token from Step 3 into the .env file.

  1. Run the Dashboard locally
npm run dev
  1. Open http://localhost:3000 with your browser to see the result.

License

This project is licensed under the MIT License.

Need help?

Community SlackTinybird Docs

Authors

About

This repository is dedicated to generating dummy data and a sample dashboard that mirrors a company that manages digital document signatures in real-time.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks