Skip to content

Commit 6a9d303

Browse files
committed
added social and custom links
1 parent 5108f0e commit 6a9d303

File tree

20 files changed

+1133
-219
lines changed

20 files changed

+1133
-219
lines changed

package-lock.json

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"@sveltejs/vite-plugin-svelte": "^5.0.0",
1919
"@tailwindcss/typography": "^0.5.15",
2020
"autoprefixer": "^10.4.20",
21-
"bits-ui": "^1.0.0-next.72",
21+
"bits-ui": "^1.0.0-next.74",
2222
"clsx": "^2.1.1",
2323
"lucide-svelte": "^0.468.0",
2424
"mode-watcher": "^0.5.0",

src/content/auth/auth.md

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

src/content/index.md

Lines changed: 43 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -1,113 +1,63 @@
11
---
2-
slug: docs
3-
title: Welcome to Svelte Firekit
4-
description: a comprehensive library integrating SvelteKit and Firebase for building robust micro SaaS applications.
2+
title: Welcome to YourDocs
3+
description: A modern documentation template built with Svelte 5, MDSvex, and Tailwind CSS.
54
---
65

7-
## Introduction to Svelte Firekit
6+
# Build beautiful documentation with ease
87

9-
Svelte Firekit is a powerful Firebase toolkit for SvelteKit applications, providing a comprehensive set of utilities, stores, and components for seamless Firebase integration. Whether you're building a micro SaaS, web application, or any Firebase-powered project, Svelte Firekit streamlines your development process.
8+
A modern documentation template built with Svelte 5, MDSvex, and Tailwind CSS. Featuring a beautiful design system powered by shadcn/ui, complete with dark mode support and full customization options.
109

11-
## Installation
10+
## Quick Start
1211

1312
```bash
14-
npm install firebase svelte-firekit
13+
# Install via npm
14+
npm install your-package-name
15+
16+
# Install via pnpm
17+
pnpm add your-package-name
18+
19+
# Install via yarn
20+
yarn add your-package-name
1521
```
1622

17-
## Configuration
23+
## Key Features
1824

19-
Svelte Firekit automatically manages your Firebase configuration through environment variables. Create a `.env` file in your project root with the following variables:
25+
### Component Library
26+
Built on top of shadcn/ui, this template offers a comprehensive set of accessible components with complete documentation. Each component is carefully crafted to be both beautiful and functional.
2027

21-
```env
22-
PUBLIC_FIREBASE_API_KEY=your_api_key
23-
PUBLIC_FIREBASE_AUTH_DOMAIN=your_auth_domain
24-
PUBLIC_FIREBASE_PROJECT_ID=your_project_id
25-
PUBLIC_FIREBASE_STORAGE_BUCKET=your_storage_bucket
26-
PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_messaging_sender_id
27-
PUBLIC_FIREBASE_APP_ID=your_app_id
28-
PUBLIC_FIREBASE_MEASUREMENT_ID=your_measurement_id
29-
```
28+
### Type-Safe Development
29+
Fully typed with TypeScript, providing excellent IDE support and a reliable development experience. Get instant feedback and catch errors before they happen.
3030

31-
The configuration is automatically handled by Firekit - no manual setup required. If any required environment variables are missing, Firekit will throw a helpful error indicating which variables need to be set.
31+
### Complete Customization
32+
Make it yours with:
33+
- Custom themes and color schemes
34+
- Flexible layout options
35+
- Customizable components
36+
- Brand integration
37+
- Dark mode support
3238

33-
## Usage Example
39+
### Modern Tech Stack
40+
- **Svelte 5** for optimal performance
41+
- **MDSvex** for enhanced markdown
42+
- **TailwindCSS** for styling
43+
- **shadcn/ui** for UI components
44+
- **TypeScript** for type safety
3445

35-
Here's a simple example showing how to display the current user's name:
46+
## Getting Started
3647

37-
```svelte
38-
<script>
39-
import { firekitUser } from 'svelte-firekit';
40-
</script>
48+
Choose the guide that works best for you:
4149

42-
Hello {firekitUser.displayName}
43-
```
50+
- [Installation Guide](/docs/installation) - Get up and running quickly
51+
- [Component Library](/docs/components) - Explore available components
52+
- [Customization](/docs/customization) - Learn how to make it your own
53+
- [Examples](/docs/examples) - See real-world usage
54+
55+
## Community and Support
4456

45-
The `firekitUser` store provides access to the current user's information and authentication state.
46-
47-
## Core Features
48-
49-
### 🔥 Firebase Integration
50-
- Zero-config Firebase setup through environment variables
51-
- Automatic initialization and app management
52-
- Built-in error handling and connection state management
53-
- Type-safe configuration management
54-
55-
### 🔐 Authentication
56-
- Complete authentication system with built-in components
57-
- Support for multiple authentication providers:
58-
- Email/Password
59-
- Google
60-
- GitHub
61-
- Custom providers
62-
- User state management and persistence through `firekitUser` store
63-
64-
### 📚 Firestore Integration
65-
- Reactive data stores for real-time updates
66-
- Simplified CRUD operations
67-
- Batch operations and transactions
68-
- Type-safe document references
69-
- Automatic data serialization/deserialization
70-
71-
### 📦 Storage Management
72-
- File upload and download utilities
73-
- Progress tracking and status updates
74-
- Storage security rules helpers
75-
- Image optimization utilities
76-
77-
### ⚡ Server-Side Rendering
78-
- Full SSR compatibility
79-
- Hydration support
80-
- Server-side data fetching
81-
- SEO-friendly rendering
82-
83-
### 🎯 Type Safety
84-
- Built with TypeScript
85-
- Complete type definitions
86-
- Intelligent autocomplete
87-
- Runtime type checking
88-
- Type-safe Firestore operations
89-
90-
## Why Svelte Firekit?
91-
92-
- **Zero Configuration**: Automatic Firebase setup through environment variables
93-
- **Type Safety**: Full TypeScript support with built-in type checking
94-
- **Rapid Development**: Get your Firebase-powered SvelteKit application up and running in minutes
95-
- **Best Practices**: Built following Firebase and SvelteKit best practices
96-
- **Production Ready**: Battle-tested in production environments
97-
- **Active Community**: Regular updates and active community support
98-
- **Extensible**: Easy to customize and extend for your specific needs
99-
100-
## Next Steps
101-
102-
- Check out our [Getting Started](/getting-started) guide
103-
- Explore the [API Reference](/api)
104-
- View [Examples](/examples)
105-
- Join our [Community](/community)
106-
107-
## Contributing
108-
109-
We welcome contributions! Please see our [Contributing Guide](/contributing) for more details.
57+
- [GitHub Repository](https://github.com/yourusername/project)
58+
- [Documentation](https://your-docs-site.com)
59+
- [Examples](https://your-docs-site.com/examples)
11060

11161
## License
11262

113-
Svelte Firekit is released under the MIT License. See the [LICENSE](/license) file for more details.
63+
Released under the MIT License. Feel free to use this template for your own projects.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<script lang="ts">
2+
import { features } from '$lib/config';
3+
</script>
4+
5+
<div class="mx-auto max-w-[85rem] px-4 py-10 sm:px-6 lg:px-8 lg:py-14">
6+
<div class="grid items-center gap-12 sm:grid-cols-2 lg:grid-cols-4">
7+
{#each features as feature}
8+
<!-- Feature Block -->
9+
<div class="text-center">
10+
<div
11+
class="mx-auto flex size-12 items-center justify-center rounded-full border border-gray-200 bg-gray-50 dark:border-neutral-700 dark:bg-neutral-800"
12+
>
13+
<feature.icon class="size-5 shrink-0 text-gray-600 dark:text-neutral-400" />
14+
</div>
15+
<div class="mt-3">
16+
<h3 class="text-lg font-semibold text-gray-800 dark:text-white">
17+
{feature.title}
18+
</h3>
19+
<p class="mt-1 text-gray-600 dark:text-neutral-400">
20+
{feature.description}
21+
</p>
22+
</div>
23+
</div>
24+
<!-- End Feature Block -->
25+
{/each}
26+
</div>
27+
</div>

src/lib/components/home/footer.svelte

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<script>
2+
import { navItems, siteConfig } from '$lib/config';
3+
import SocialMedia from '../social-media.svelte';
4+
</script>
5+
6+
<footer class="mx-auto mt-auto w-full max-w-[85rem] px-4 py-10 sm:px-6 lg:px-8">
7+
<div class="grid grid-cols-1 items-center gap-5 md:grid-cols-3">
8+
<div>
9+
<a href="/">
10+
<img src={siteConfig.logo} alt={siteConfig.title} class="h-6 dark:hidden" />
11+
<img src={siteConfig.logoDark} alt={siteConfig.title} class="hidden h-6 dark:block" />
12+
</a>
13+
</div>
14+
15+
<ul class="text-center">
16+
{#each navItems as item}
17+
<li
18+
class="relative inline-block pe-8 before:absolute before:end-3 before:top-1/2 before:-translate-y-1/2 before:text-gray-300 before:content-['/'] last:pe-0 last-of-type:before:hidden dark:before:text-neutral-600"
19+
>
20+
<a
21+
class="inline-flex gap-x-2 text-sm text-gray-500 hover:text-gray-800 focus:text-gray-800 focus:outline-none dark:text-neutral-500 dark:hover:text-neutral-200 dark:focus:text-neutral-200"
22+
href={item.href}
23+
>
24+
{item.title}
25+
</a>
26+
</li>
27+
{/each}
28+
</ul>
29+
30+
<SocialMedia />
31+
</div>
32+
</footer>

0 commit comments

Comments
 (0)