Skip to content

Commit d6d1e88

Browse files
authored
update template (#32)
1 parent 97bee23 commit d6d1e88

File tree

2 files changed

+8
-16
lines changed

2 files changed

+8
-16
lines changed

TEMPLATE.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,10 @@
1-
This is a template for a log analytics web application. It is built with Next.js and [Tinybird](https://tinybird.co).
1+
This is a template for a custom log analytics web application. It is built with Next.js and [Tinybird](https://tinybird.co).
22

33
You can use this template to bootstrap logging analytics for any software project. Fork it and make it your own!
44

55
## Quick Start
66

7-
Deploy the Tinybird and Next.js to the cloud to get started quickly.
8-
9-
<p align="left">
10-
<a href="https://app.tinybird.co?starter_kit=https://github.com/tinybirdco/log-analytics-template/tinybird">
11-
<img width="200" src="https://img.shields.io/badge/Deploy%20to-Tinybird-25283d?style=flat&labelColor=25283d&color=27f795&logo=data:image/svg+xml;base64,PHN2ZyB2aWV3Qm94PSIwIDAgNTAwIDUwMCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCBkPSJNNTAwIDQyLjhsLTE1Ni4xLTQyLjgtNTQuOSAxMjIuN3pNMzUwLjcgMzQ1LjRsLTE0Mi45LTUxLjEtODMuOSAyMDUuN3oiIGZpbGw9IiNmZmYiIG9wYWNpdHk9Ii42Ii8+PHBhdGggZD0iTTAgMjE5LjlsMzUwLjcgMTI1LjUgNTcuNS0yNjguMnoiIGZpbGw9IiNmZmYiLz48L3N2Zz4=" />
12-
</a>
13-
</p>
14-
15-
[![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Ftinybirdco%2Flog-analytics-template&project-name=tinybird-log-analytics-template&repository-name=tinybird-log-analytics-template&demo-description=Custom%20analytics%20for%20your%20application%20logs%20using%20Tinybird&demo-url=http%3A%2F%2Flog-analytics.tinybird.co&demo-image=//github.com/tinybirdco/log-analytics-starter-kit/blob/main/dashboard/public/banner.png?raw=true&root-directory=dashboard&integration-ids=oac_uoH2YyxhaS1H6UYvtuRbRbDY)
7+
Deploy the project to [Tinybird](https://app.tinybird.co?starter_kit=https://github.com/tinybirdco/log-analytics-template/tinybird) and [Vercel](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Ftinybirdco%2Flog-analytics-template&project-name=tinybird-log-analytics-template&repository-name=tinybird-log-analytics-template&demo-description=Custom%20analytics%20for%20your%20application%20logs%20using%20Tinybird&demo-url=https%3A%2F%2Flogs.tinybird.app&demo-image=//github.com/tinybirdco/log-analytics-template/blob/main/dashboard/log-analyzer/public/banner.png?raw=true&root-directory=dashboard/log-analyzer) to get started quickly.
168

179
Configure your Tinybird environment variables in Vercel:
1810

@@ -29,7 +21,7 @@ Get started by forking the repository and then customizing it to your needs.
2921

3022
Start Tinybird locally:
3123

32-
```bash
24+
```sh
3325
cd tinybird
3426
tb local start
3527
tb login
@@ -39,29 +31,29 @@ token ls # copy an admin token
3931

4032
Configure the Next.js application:
4133

42-
```bash
34+
```sh
4335
cd dashboard/log-analyzer
4436
cp .env.example .env
4537
```
4638

4739
Edit the `.env` file with your Tinybird API key and other configuration.
4840

49-
```bash
41+
```sh
5042
NEXT_PUBLIC_TINYBIRD_API_KEY=<YOUR_TINYBIRD_ADMIN_TOKEN>
5143
NEXT_PUBLIC_TINYBIRD_API_URL=http://localhost:7181
5244
```
5345

5446
Start the Next.js application:
5547

56-
```bash
48+
```sh
5749
cd dashboard/log-analyzer
5850
npm install
5951
npm run dev
6052
```
6153

6254
Open the application in your browser:
6355

64-
```bash
56+
```sh
6557
http://localhost:3000
6658
```
6759

@@ -112,7 +104,7 @@ Check the [examples/vector](./examples/vector) folder for an example of how to d
112104

113105
Deploy the Tinybird project to the cloud:
114106

115-
```bash
107+
```sh
116108
cd tinybird
117109
tb --cloud deploy
118110
```
96.6 KB
Loading

0 commit comments

Comments
 (0)