Skip to content

Latest commit

 

History

History
99 lines (61 loc) · 2.99 KB

README.md

File metadata and controls

99 lines (61 loc) · 2.99 KB

Dashboard Starter Kit

This is a tool to consume the pipes and visualize all the events that has been sent to your data project.

Tech stack

To build this Starter Kit template we have used:

How to use it?

Install

First of all, you have to clone the repo if you haven't already

$ git clone [email protected]:tinybirdco/web-analytics-starter-kit.git

Then navigate into the /dashboard folder and install the dependencies

$ cd web-analytics-starter-kit/dashboard
$ npm install

Build for Development

Once you have installed the dependencies, run:

npm run dev

You will find the app running at http://localhost:3000

Copy the .env.example file and rename it to .env.

NEXT_PUBLIC_TINYBIRD_DASHBOARD_URL=http://localhost:3000
NEXT_PUBLIC_TINYBIRD_TRACKER_TOKEN=<YOUR_TINYBIRD_TRACKER_TOKEN>
NEXT_PUBLIC_TINYBIRD_AUTH_TOKEN=<YOUR_TINYBIRD_AUTH_TOKEN>
NEXT_PUBLIC_TINYBIRD_HOST=<YOUR_TINYBIRD_HOST>

To develop locally, start Tinybird Local and use http://localhost as NEXT_PUBLIC_TINYBIRD_HOST.

Build for Production

npm run build
npm run start

And you will find the app running at but with the production bundle http://localhost:3000

Deployment

Deploy it to the cloud with Vercel (Documentation).

Contributing

Contributions are always welcome. To contribute, commit your changes into a new branch, and open a pull request against the main branch.

Please be careful in describing the problem and the implemented solution so that we can make the best review possible.

Issues

Also, you can open an issue if you've encountered a bug or an enhancement on the Dashboard.

Customization

We encourage you to fork the repo and customize the dashboard adapting it to your needs and to your branding image.

You will be able to change the main colors, the font and other theme configration modifying the tailwind.config.js file. However, colors defined in styles/theme/tremor-colors.ts are predefined and cannot be changed

Authors

Rafa Moreno

Raquel Yuste

Licence

MIT License

Copyright (c) 2022 Tinybird.co

Permission is hereby granted, free of charge, to any person obtaining a copy