project-conventions

Enforce naming and folder structure conventions for React TypeScript admin templates.

3|Updated Apr 5, 2024
One-click install
npx skills add https://github.com/danghungtb26/admin-react-typescript-template --skill project-conventions-danghungtb26
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-conventions
Source: https://github.com/danghungtb26/admin-react-typescript-template/tree/main/.agents/skills/project-conventions
Command: npx skills add https://github.com/danghungtb26/admin-react-typescript-template --skill project-conventions-danghungtb26

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill codifies and enforces project-wide conventions for this React TypeScript admin template, ensuring consistent structure, naming, and organization across files, components, APIs, hooks, and routes.

Core Features & Use Cases

  • Establishes kebab-case file naming, PascalCase components, and camelCase hooks.
  • Defines standard folder structures for features (containers), APIs (cores/hooks), and routing patterns.
  • Guides new contributors by providing a single source of truth when creating new code assets, improving maintainability and onboarding.

Quick Start

Adopt these conventions when creating new files, components, APIs, hooks, containers, or routes in the template. Consult the naming, folder-structure, and API pattern references to align with project-wide standards. Example: name new models and APIs using kebab-case files, PascalCase components, and camelCase hooks.

Frequently Asked Questions about project-conventions

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

FAQPage Schema
How do I enforce consistent naming conventions in a React TypeScript project?

To enforce consistent naming conventions in React TypeScript, apply kebab-case for file names, PascalCase for components, and camelCase for hooks. This establishes a single source of truth for new contributors, improving maintainability and onboarding.

What is the standard folder structure for React TypeScript admin templates?

The standard folder structure for React TypeScript admin templates organizes feature containers, API cores, hooks, and routing patterns into defined directories. This ensures consistent organization across files, components, APIs, and routes.

How do I structure APIs and routing in a React TypeScript admin template?

To structure APIs and routing in a React TypeScript admin template, follow standard folder patterns for cores, hooks, and routes. Name new models and APIs using kebab-case files while maintaining camelCase hooks for consistency.

Why use kebab-case file naming with PascalCase components in React?

Using kebab-case file naming with PascalCase components in React codifies project-wide conventions into a single source of truth. This standardization prevents structural inconsistencies and guides new contributors when creating code assets.

Can I apply these React TypeScript folder structure conventions to existing projects?

Yes, you can apply these React TypeScript folder structure conventions to existing projects by aligning new files, components, and APIs with the defined kebab-case, PascalCase, and camelCase standards during ongoing development.