Skip to content

chore(agent-readiness): bootstrap basic AGENTS.md and minor README up… #4973

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
johnmcollier wants to merge 1 commit into
base: main
Choose a base branch
from
+57 −1
Open

chore(agent-readiness): bootstrap basic AGENTS.md and minor README up… #4973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# rhdh

Enterprise-grade Internal Developer Portal based on Backstage, with dynamic plugin support.

## Build & Test Commands

- Install: `yarn install`
- Build all: `yarn build`
- Dev (frontend + backend): `yarn dev`
- Start (backend only): `yarn start`
- Test all: `yarn test`
- Lint check: `yarn lint:check`
- Lint fix: `yarn lint:fix`
- Type check: `yarn tsc`
- Format check: `yarn prettier:check`
- Format fix: `yarn prettier:fix`
- Single-file lint: `npx eslint <path/to/file.ts>`
- Single-file type check: `yarn tsc --noEmit` (from the relevant package directory)
- Clean: `yarn clean`

Turborepo is used for task orchestration. Scope to a single package with `--filter`:

```bash
yarn build --filter=backend
yarn test --filter=@internal/plugin-scalprum-backend
```

## Key Conventions

<!-- 3-5 rules the agent can't infer from the code itself -->

## Architecture

<!-- Where to find things that aren't obvious from directory names -->
1 change: 1 addition & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@AGENTS.md
23 changes: 22 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,15 @@ Our current list of plugins include:

## Getting Started

Dependencies:
### Quick Start

```bash
corepack enable # Enable Yarn via corepack (one-time)
yarn install # Install all dependencies
yarn dev # Start frontend + backend
```

### Prerequisites

- [Node.js](https://nodejs.org/en/) - [required version](.nvmrc)
- [corepack](https://github.com/nodejs/corepack)
Expand All @@ -59,6 +67,19 @@ We are excited to see people wanting to contribute to our project and welcome an

We also welcome non code contributions in the form of bug reporting and documentation writing. If you run across any bugs, please raise an issue here in [JIRA](https://issues.redhat.com/browse/RHDHBUGS).

## Usage

After completing setup, start the application locally:

```bash
yarn dev # Start both frontend and backend (recommended for development)
yarn start # Start backend only
```

The frontend is available at `http://localhost:3000` and the backend at `http://localhost:7007`.

For production deployments on OpenShift, see the [Getting Started documentation](https://github.com/redhat-developer/rhdh/blob/main/docs/index.md).

## Community, Discussion, and Support

[Bugs](https://issues.redhat.com/projects/RHDHBUGS) should be filled out here on RHDHBUGS Jira.
Expand Down
Loading