Skip to content

Commit c3dc255

Browse files
committed
Gemini Change Optimizations
1 parent 19f9f36 commit c3dc255

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

GEMINI.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,41 @@
11
# Gemini Project Helper
22

3-
This document provides guidance for the Gemini AI assistant on how to interact with the `outfoxweb-astro` project.
3+
This document provides guidance for the Gemini AI assistant on how to interact with the `sveltekit-convex-clerk-template` project.
44

55
## Project Overview
66

7-
This is a modern website built using the Astro framework. It appears to be a portfolio or agency website, with a focus on web development, design, and SEO services. The project uses Svelte for interactive UI components and TypeScript for type safety.
7+
This is a template for a modern web application built with SvelteKit for the frontend, Convex for the backend, and Clerk for authentication. It includes a basic dashboard and marketing page structure, as well as a variety of UI components.
88

99
## Technologies
1010

11-
- **Framework**: [Astro](https://astro.build/)
11+
- **Framework**: [SvelteKit](https://kit.svelte.dev/)
12+
- **Backend**: [Convex](https://www.convex.dev/)
13+
- **Authentication**: [Clerk](https://clerk.com/)
1214
- **UI Components**: [Svelte](https://svelte.dev/)
1315
- **Styling**: [Tailwind CSS](https://tailwindcss.com/)
1416
- **Language**: [TypeScript](https://www.typescriptlang.org/)
15-
- **Package Manager**: [Yarn](https://yarnpkg.com/)
16-
- **Content**: Astro Content Collections (for the blog)
17+
- **Package Manager**: [npm](https://www.npmjs.com/)
1718

1819
## Key Directories
1920

20-
- `src/pages`: Contains the site's pages and API routes. Each file corresponds to a URL endpoint.
21-
- `src/components`: Houses reusable UI components, primarily written in Svelte (`.svelte`).
22-
- `src/layouts`: Defines the overall page structure, like the main `Layout.astro`.
23-
- `src/content`: Manages content collections, such as blog posts in `src/content/blog/`.
24-
- `src/styles`: Contains global CSS and Tailwind CSS configuration.
21+
- `src/routes`: Contains the site's pages. SvelteKit uses a file-based routing system.
22+
- `src/lib/components`: Houses reusable UI components, primarily written in Svelte (`.svelte`).
23+
- `src/lib/stores`: Contains Svelte stores for state management.
24+
- `src/convex`: Manages the Convex backend, including the schema and tasks.
2525
- `public/`: Stores static assets like images, fonts, and favicons that are copied directly to the build output.
2626

2727
## Common Commands
2828

29-
The project uses `yarn` as its package manager. The following commands are likely configured in `package.json`:
29+
The project uses `npm` as its package manager. The following commands are configured in `package.json`:
3030

31-
- **Start development server**: `yarn dev`
32-
- **Create a production build**: `yarn build`
33-
- **Preview the production build**: `yarn preview`
34-
- **Run Astro's type-checker**: `yarn astro check`
35-
- **Linting**: Check `package.json` for a `lint` script.
31+
- **Start Convex dev server**: `npm run convex:dev`
32+
- **Start development server**: `npm run dev`
33+
- **Create a production build**: `npm run build`
34+
- **Preview the production build**: `npm run preview`
35+
- **Run Svelte type-checker**: `npm run check`
36+
- **Linting**: `npm run lint`
37+
- **Formatting**: `npm run format`
38+
- **Run tests**: `npm run test`
3639

3740
When making changes, please adhere to the existing coding style, including TypeScript best practices and the conventions used in the Astro and Svelte components.
3841

@@ -42,7 +45,7 @@ For specific guidelines on the technologies used in this project, please refer t
4245

4346
- **Svelte 5:** Refer to `instructions/svelte_rules.md` for comprehensive rules on Svelte 5 development, including the mandatory use of the Runes system, state management patterns, and component best practices.
4447
- **Convex:** Refer to `instructions/convex_rules.md` for guidelines on schema design, queries, mutations, actions, and other Convex-specific features.
45-
- **Svelte + Convex Integration:** Refer to `instructions/svelte_and_convex.md` for information on how to use Svelte with Convex, including a link to the `convex-svelte` client-side package documentation.
48+
- **Svelte + Convex Integration:** Refer to `instructions/svelte_and_convex.md` for information on how to use Svelte with Convex, including a link to the [`convex-svelte` client-side package documentation](https://www.npmjs.com/package/convex-svelte).
4649

4750
# General Coding Style Rules
4851

0 commit comments

Comments
 (0)