Skip to content

Commit d8cd5bf

Browse files
devgauravjattdevgauravjatt
committed
✨ feat(project): initial project setup
- added basic project structure - added tailwindcss for styling - added readme file explaining project features - created basic layout and page component - implemented basic markdown rendering for readme - added global styles for markdown rendering
1 parent c8adea3 commit d8cd5bf

File tree

9 files changed

+337
-223
lines changed

9 files changed

+337
-223
lines changed

‎astro.config.mjs‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
// @ts-check
22
import { defineConfig } from 'astro/config';
33

4+
import tailwindcss from '@tailwindcss/vite';
5+
46
// https://astro.build/config
5-
export default defineConfig({});
7+
export default defineConfig({
8+
vite: {
9+
plugins: [tailwindcss()]
10+
}
11+
});

‎bun.lock‎

Lines changed: 105 additions & 0 deletions
Large diffs are not rendered by default.

‎package.json‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99
"astro": "astro"
1010
},
1111
"dependencies": {
12-
"astro": "^5.9.1"
12+
"@geoffcodesthings/tailwind-md-base": "^1.1.0",
13+
"@tailwindcss/vite": "^4.1.8",
14+
"astro": "^5.9.1",
15+
"tailwindcss": "^4.1.8"
1316
}
1417
}

‎src/components/Welcome.astro‎

Lines changed: 0 additions & 210 deletions
This file was deleted.

‎src/components/readme.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# 📚 Drizzle Setup CLI
2+
3+
A powerful CLI tool to automatically scaffold and configure database setup using **Drizzle ORM** for PostgreSQL,SQLite,MySQL and More.
4+
5+
---
6+
7+
## ✨ Features
8+
9+
- 📦 **Zero Config Setup** – Instantly scaffold DB structure and config with minimal input.
10+
- 📜 **Drizzle Scripts** – Automatically updates `package.json` with Drizzle CLI scripts.
11+
- 🔧 **.env Auto Update** – Automatically injects required environment variables.
12+
- 🧩 **Multiple DB Support** – Works seamlessly with PostgreSQL,SQLite,MySQL and More setups.
13+
- 📁 **Template Copying** – Instantly sets up a working `target-folder` structure.
14+
15+
---
16+
17+
## 📦 Installation
18+
19+
Install globally via your preferred package manager:
20+
21+
```bash
22+
npm install -g drizzle-setup
23+
# or
24+
npx drizzle-setup
25+
```
26+
27+
---
28+
29+
## 🚀 Quick Start
30+
31+
Just run the CLI in your project directory:
32+
33+
```bash
34+
drizzle-setup
35+
```
36+
37+
You'll be guided through:
38+
39+
1. **Choosing your database** (PostgreSQL or SQLite moreover)
40+
2. **Selecting a config preset**
41+
3. **Specifying a target folder**
42+
4. **Copying boilerplate files**
43+
5. **Setting up `drizzle.config.ts`**
44+
6. **Updating `.env` and `package.json`**
45+
7. **Installing dependencies** via your chosen package manager
46+
47+
---
48+
49+
## 🧪 Supported Databases
50+
51+
- PostgreSQL - Default, Neon
52+
- SQLite - Default, Turso, Bun SQLite
53+
54+
Each database type comes with its own pre-configured templates and `.env` variables.
55+
56+
---
57+
58+
## 🧱 Directory Structure
59+
60+
After setup, your project might look like this:
61+
62+
```
63+
project-root/
64+
├── drizzle.config.ts
65+
├── .env
66+
├── [target-folder]/
67+
│ ├── schema.ts
68+
│ └── index.ts
69+
```
70+
71+
---
72+
73+
## 📄 License
74+
75+
MIT License
76+
77+
---

‎src/layouts/Layout.astro‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
1+
---
2+
import '../styles/global.css'
3+
---
4+
15
<!doctype html>
2-
<html lang="en">
6+
<html lang='en'>
37
<head>
4-
<meta charset="UTF-8" />
5-
<meta name="viewport" content="width=device-width" />
6-
<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
7-
<meta name="generator" content={Astro.generator} />
8+
<meta charset='UTF-8' />
9+
<meta name='viewport' content='width=device-width' />
10+
<link rel='icon' type='image/svg+xml' href='/favicon.svg' />
11+
<meta name='generator' content={Astro.generator} />
812
<title>Astro Basics</title>
913
</head>
1014
<body>

‎src/pages/index.astro‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
2-
import Welcome from '../components/Welcome.astro';
3-
import Layout from '../layouts/Layout.astro';
4-
5-
// Welcome to Astro! Wondering what to do next? Check out the Astro documentation at https://docs.astro.build
6-
// Don't want to use any of this? Delete everything in this file, the `assets`, `components`, and `layouts` directories, and start fresh.
2+
import Welcome from '../components/readme.md'
3+
import Layout from '../layouts/Layout.astro'
74
---
85

96
<Layout>
10-
<Welcome />
7+
<div class='content max-w-3xl mx-auto mt-10'>
8+
<Welcome />
9+
</div>
1110
</Layout>

0 commit comments

Comments
 (0)