https://github.com/tinybirdco/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.
https://github.com/tinybirdco/signatures-poc
clickhouse nextjs sql tinybird tremor
Last synced: 7 months ago
JSON representation
This repository is dedicated to generating dummy data and a sample dashboard that mirrors a company that manages digital document signatures in real-time.
- Host: GitHub
- URL: https://github.com/tinybirdco/signatures-poc
- Owner: tinybirdco
- License: mit
- Created: 2023-06-26T21:32:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-18T16:52:53.000Z (over 2 years ago)
- Last Synced: 2025-01-10T03:56:21.423Z (about 1 year ago)
- Topics: clickhouse, nextjs, sql, tinybird, tremor
- Language: JavaScript
- Homepage:
- Size: 184 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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.
## 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 👇
[](https://ui.tinybird.co/workspaces/new?name=signatures_poc)
Follow the guided process, and your Tinybird workspace is now ready to start receiving events.
2. Setup this repository locally
```bash
git clone https://github.com/tinybirdco/signatures-POC.git
cd signatures-POC
```
3. Install dependencies
```bash
npm install
```
4. 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](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](https://www.tinybird.co/docs/api-reference/token-api.html)
This script will also push the data project to your Tinybird workspace.
5. Start generating data!
In the terminal, run the following command:
```bash
npm run seed
```
Go to your [Tinybird workspace](https://ui.tinybird.co) and check the data is flowing.
6. 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.
7. Copy the environment variables to .env
Locally, be sure to paste the admin token from Step 3 into the `.env` file.
8. Run the Dashboard locally
```bash
npm run dev
```
9. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
### License
This project is licensed under the MIT License.
### Need help?
• [Community Slack](https://www.tinybird.co/join-our-slack-community) • [Tinybird Docs](https://docs.tinybird.co/) •
## Authors
* [Joe Karlsson](https://github.com/joekarlsson)