Skip to content

Commit 2b73db9

Browse files
committed
cleanup readme
1 parent 16fccb9 commit 2b73db9

File tree

1 file changed

+24
-14
lines changed

1 file changed

+24
-14
lines changed

README.md

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
[![GitHub Stars](https://img.shields.io/github/stars/databuddy-analytics/Databuddy?style=social)](https://github.com/databuddy-analytics/Databuddy/stargazers)
2121
[![Twitter](https://img.shields.io/twitter/follow/trydatabuddy?style=social)](https://twitter.com/trydatabuddy)
2222

23-
2423
</div>
2524

2625
A comprehensive analytics and data management platform built with Next.js, TypeScript, and modern web technologies. Databuddy provides real-time analytics, user tracking, and data visualization capabilities for web applications.
@@ -38,7 +37,7 @@ A comprehensive analytics and data management platform built with Next.js, TypeS
3837
- 🎯 Goal tracking
3938
- 📈 Conversion analytics
4039
- 🔍 Custom event tracking
41-
- 📊 Funnel analysis
40+
- 📊 Funnel analysis
4241
- 📈 Cohort analysis // Soon
4342
- 🔄 A/B testing // Soon
4443
- 📈 Export capabilities // Soon
@@ -48,7 +47,6 @@ A comprehensive analytics and data management platform built with Next.js, TypeS
4847

4948
## 📚 Table of Contents
5049

51-
- [Project Structure](#project-structure)
5250
- [Getting Started](#getting-started)
5351
- [Development](#development)
5452
- [Contributing](#contributing)
@@ -70,25 +68,26 @@ A comprehensive analytics and data management platform built with Next.js, TypeS
7068
### Installation
7169

7270
1. Clone the repository:
71+
7372
```bash
7473
git clone https://github.com/databuddy/databuddy.git
7574
cd databuddy
7675
```
7776

78-
2. Install dependencies (Bun only):
77+
2. Install dependencies:
78+
7979
```bash
8080
bun install
8181
```
8282

8383
3. Set up environment variables:
84+
8485
```bash
85-
cp apps/dashboard/.env.example apps/dashboard/.env
86-
cp apps/landing/.env.example apps/landing/.env
87-
cp apps/admin/.env.example apps/admin/.env
88-
cp apps/api/.env.example apps/api/.env
86+
cp .env.example .env
8987
```
9088

91-
4. Start development servers (Bun only):
89+
4. Start development servers:
90+
9291
```bash
9392
bun run dev
9493
```
@@ -99,12 +98,16 @@ bun run dev
9998

10099
Check the root `package.json` for available scripts. Here are some common ones:
101100

102-
- `bun run dev` - Start all applications in development mode (if defined)
101+
- `bun run dev` - Start all applications in development mode
102+
- `bun run build` - Build all applications
103+
- `bun run start` - Start all applications in production mode
104+
- `bun run lint` - Lint all code with Ultracite
105+
- `bun run format` - Format all code with Prettier
106+
- `bun run check-types` - Type check all TypeScript code
103107
- `bun run db:studio` - Open Drizzle Studio for database management
104-
- `bun run clickhouse:init` - Initialize ClickHouse tables
105108
- `bun run db:generate` - Generate Drizzle ORM types
106-
- `bun run db:push` - Apply database migrations
107-
- `bun run db:migrate` - Generate and run migrations
109+
- `bun run db:push` - Apply database schema changes
110+
- `bun run db:migrate` - Run database migrations
108111
- `bun run db:deploy` - Deploy database migrations
109112
- `bun run sdk:build` - Build the SDK package
110113
- `bun run email:dev` - Start the email development server
@@ -114,29 +117,34 @@ You can also `cd` into any package and run its scripts directly.
114117
### Development Workflow
115118

116119
1. Create a new branch:
120+
117121
```bash
118122
git checkout -b feature/your-feature
119123
```
120124

121125
2. Make your changes
122126

123127
3. Run tests:
128+
124129
```bash
125130
bun run test
126131
```
127132

128133
4. Create a changeset:
134+
129135
```bash
130136
bun run changeset
131137
```
132138

133139
5. Commit your changes:
140+
134141
```bash
135142
git add .
136143
git commit -m "feat: your feature"
137144
```
138145

139146
6. Push your changes:
147+
140148
```bash
141149
git push origin feature/your-feature
142150
```
@@ -170,7 +178,7 @@ See [SECURITY.md](SECURITY.md) for reporting vulnerabilities.
170178
See [Prerequisites](#prerequisites).
171179

172180
2. **How do I deploy?**
173-
See [Deployment](#deployment).
181+
See the deployment documentation in our [docs](https://docs.databuddy.cc).
174182

175183
3. **How do I contribute?**
176184
See [Contributing](#contributing).
@@ -207,5 +215,7 @@ See [ACKNOWLEDGMENTS.md](ACKNOWLEDGMENTS.md) for credits.
207215
- **Always use error boundaries properly.**
208216
- **Console usage:** Use `console.error`, `console.time`, `console.json`, `console.table`, etc. appropriately.
209217
- **Almost never use useEffect** unless critical.
218+
- **Use Ultracite** for linting and formatting.
219+
- **Use Prettier** for code formatting.
210220

211221
See `.cursor/rules/` for the full enforced ruleset.

0 commit comments

Comments
 (0)