Conversation
Add CLAUDE.md providing guidance for Claude Code when working with this repository. The file summarizes the project structure (API and Frontend services), startup notes (both run in Docker; start the API first), quick CLI commands for running tests/lint/typecheck and regenerating the API client, and key implementation patterns (CommonController, BaseDecorator hooks, Orval-generated client, TanStack Router layout).
fluxsaas
changed the title
martingregoire
approved these changes
Feb 6, 2026
| bin/dev exec frontend pnpm test # Tests | ||
| bin/dev exec frontend pnpm typecheck # TypeScript | ||
| bin/dev exec frontend pnpm lint # ESLint | ||
| bin/generate-api # Regenerate API client after API changes |
Collaborator
There was a problem hiding this comment.
Let's also include a step in the API section above to generate the API schema:
bin/dev exec api bundle exec rails rswag
| bin/dev exec frontend pnpm test # Tests | ||
| bin/dev exec frontend pnpm typecheck # TypeScript | ||
| bin/dev exec frontend pnpm lint # ESLint | ||
| bin/generate-api # Regenerate API client after API changes |
Collaborator
There was a problem hiding this comment.
Oh, also we could remove this script bin/generate-api (it is only one command), and run the command directly. WDYT? We would need to change the frontend/README.md as well.
Suggested change
| bin/generate-api # Regenerate API client after API changes | |
| bin/dev exec frontend pnpm generate-api # Regenerate API client after API changes |
|
|
||
| **BaseDecorator** (`api/app/decorators/base_decorator.rb`) — Wraps create/update/destroy with hooks (`before_assign_attributes`, `after_save`, `update_state` for AASM transitions). | ||
|
|
||
| **Orval API Client** (`frontend/src/generated/`) — Generated from OpenAPI spec. Run `bin/generate-api` in frontend after API changes. |
Collaborator
There was a problem hiding this comment.
Let's include both steps here then, first generate the schema in the API, then generate the hooks in the frontend.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Any closed tickets?
None
Dependencies?
None
What?
Adds a
CLAUDE.mdfile to provide context and instructions for Claude Code when working with this repository.Why?
Claude Code reads
CLAUDE.mdfiles to understand project structure, conventions, and common commands. Having this file enables more effective AI-assisted development by giving Claude immediate context about the codebase.How?
Added a single markdown file covering:
Testing?
Manual verification that Claude Code reads and applies the guidance correctly.