skills.rest
proofgeist
proofgeistOFFICIAL
Explore all skills by this author →
GitHub

getting-started

Guide ProofKit project setup with Node.js, pnpm, and FileMaker prerequisites.

17|5|Updated Sep 24, 2024
Search Tags:#typescript#getting started#scaffolding#setup#filemaker#proofkit
One-click install
npx skills add https://github.com/proofgeist/proofkit --skill getting-started-proofgeist
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: getting-started
Source: https://github.com/proofgeist/proofkit/tree/main/packages/typegen/skills/getting-started
Command: npx skills add https://github.com/proofgeist/proofkit --skill getting-started-proofgeist

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill simplifies the initial setup and configuration of new ProofKit projects, ensuring all prerequisites are met and guiding users through the scaffolding process.

Core Features & Use Cases

  • Project Scaffolding: Creates new ProofKit projects with create-proofkit.
  • Environment Setup: Guides users on necessary Node.js, pnpm, FileMaker Server, and OttoFMS configurations.
  • API Integration: Facilitates setting up connections for both FileMaker Data API and OData.
  • Type Generation: Integrates with @proofkit/typegen for schema generation.
  • Use Case: A new developer needs to start a web application that interacts with FileMaker. This Skill helps them quickly scaffold the project, configure the necessary environment variables, and generate initial type definitions for their FileMaker layouts.

Quick Start

Run pnpm create proofkit@latest to scaffold a new ProofKit project.

Frequently Asked Questions about getting-started

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up a new ProofKit project with FileMaker?▼

ProofKit project scaffolding requires Node.js and pnpm installed on your system. You also need access to FileMaker Server and OttoFMS to properly configure the Data API or OData connections during setup.

How do I configure environment variables for FileMaker Data API and OData connections?▼

Configuring FileMaker Data API and OData connections involves setting specific environment variables during ProofKit setup. The Skill guides you through defining these variables to establish secure communication with your FileMaker Server.

How do I generate TypeScript types for FileMaker layouts in a ProofKit project?▼

Type generation for FileMaker layouts uses the `@proofkit/typegen` package. It reads your FileMaker schema and outputs TypeScript definitions, ensuring type-safe interactions between your web application and FileMaker database.

Do I need OttoFMS to use ProofKit for FileMaker web development?▼

OttoFMS is required for ProofKit setup to facilitate communication with FileMaker Server. It acts as a middleware layer that supports the Data API and OData connections needed by your scaffolded ProofKit project.

What is the best way to scaffold a TypeScript web app that connects to FileMaker?▼

The best way to scaffold a TypeScript web app for FileMaker is using the `create-proofkit` command. It handles project initialization, dependency installation, and initial configuration for seamless FileMaker database integration.

Related Skills

Explore More Software Engineering Skills→
proofgeistproofgeist
17

fmdapi-client

Manage FileMaker Data API sessions and perform CRUD operations with TypeScript.

Official
Advanced
proofgeistproofgeist
17

typegen-setup

Generate TypeScript types and Zod validators from FileMaker layouts or OData metadata.

Official
Intermediate
proofgeistproofgeist
17

fmodata-client

Interact with the FileMaker Data API using type-safe TypeScript queries.

Official
Advanced
memorysavermemorysaver

better-auth-best-practices

Integrate Better Auth into TypeScript projects with CLI migrations.

Community
Intermediate