Skip to content

Commit 18697f3

Browse files
committed
Adding an initial gemini file
1 parent 38aa420 commit 18697f3

File tree

4 files changed

+69
-0
lines changed

4 files changed

+69
-0
lines changed

firestore/.gemini/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
agents/
2+
plans/
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Goal
2+
3+
You are an agent that is excellent at doing archeology on a code repository to understand what it is for, how it works, and document your findings to help human maintainers and ai coding agents.
4+
5+
# Approach
6+
7+
You will use a multi-phased approach detailed below to accomplish your goal.
8+
9+
# Phase 1 - Discovery
10+
- **Project archeology** Ask questions to understand the intended purpose of this repository. Look for evidence to support these claims.
11+
- **Architectural archeology** - look for sub projects, patterns across files, identify integration points, and understand the overall design.
12+
- **Build archeology** - look at the package manager in all projects to understand how to build them. For each sub project, make sure to understand critical dependencies and why they are set up the way they are.
13+
- **Test archeology** - look at the package manager in all projects to understand how to test them. For each sub project, make sure to understand how testing and verification is approached. For example, UI based applications will requires visual verification.
14+
15+
# Phase 2 - Analysis
16+
- Synthesize a list of important facts you understand about the codebase.
17+
- Ask me questions to help verify all the facts systematically.
18+
- Think carefully about a way to organize all of this information into the `docs/` folder in an easy to navigate structure
19+
20+
# Phase 3 - Create the Documentation
21+
- Generate the documentation files
22+
- Once they are generated, re-read all of them from scratch and improve them for clarity and organization. Remove duplication, rendundancies, and have documents reference each other.
23+
24+
25+
# Other instructions
26+
- Ignore `README.md` as it might be stale
27+
- Put all documentation in `docs/`
28+
- Verify all claims in documentation
29+
- Use simple, concise human readable langaguage

firestore/GEMINI.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Friendly Eats
2+
3+
A Firestore quickstart application for the web
4+
5+
- This folder contains the frontend logic
6+
- `functions/` contains the backend logic
7+
- `scripts/` has helper code for the firebase emulator
8+
9+
## Architecture
10+
- Use `npm` for dependencies. Always ask before adding a new dependency.
11+
- Use typescript for coding
12+
- This is a simple Angular web application
13+
- Source code is in `src/`
14+
15+
## Essential commands
16+
- Build with `npm build`
17+
- Run tests with `npm test`
18+
- Format code with `npm fmt`
19+
20+
## Workflow
21+
- Use a separate git branch for each major task
22+
- Make small commits frequently
23+
- Use conventional commits messages
24+
- Format code files before making commits
25+
- Ensure tests pass before making commits
26+
- Changes to the frontend and backend should happen in separate commits

firestore/functions/GEMINI.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Friendly Eats backend logic
2+
3+
This folder contains the backend logic for the firestore friendly eats sample application. This folder should be considered separate from the frontend. It has separate essential commands for building and running the api server.
4+
5+
## Overview
6+
- Source code is in @src
7+
- The backend logic is a firebse function that uses firebase functions and firestore triggers
8+
9+
## Essential commands
10+
- Build with `npm build`
11+
- Run the api server through `npm run serve`
12+
- There are no tests for this project

0 commit comments

Comments
 (0)