Skip to content

Commit db3234a

Browse files
committed
docs: add agent workflows for frontend, backend, and extension
1 parent 6f39134 commit db3234a

3 files changed

Lines changed: 96 additions & 0 deletions

File tree

.agent/workflows/backend.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
description: How to manage and deploy the verifyOS-backend service
3+
---
4+
5+
// turbo-all
6+
# Backend Management Workflow
7+
8+
This workflow covers development and deployment for the verifyOS-backend located in `apps/backend`.
9+
10+
## Local Development
11+
12+
1. Navigate to the backend directory:
13+
`cd apps/backend`
14+
15+
2. Run the server in development mode:
16+
`cargo run`
17+
18+
3. The server will be available at `http://localhost:7070`.
19+
20+
## Deployment to AWS App Runner
21+
22+
This service is deployed manually using the included deployment script.
23+
24+
1. Ensure your AWS CLI is configured with correct credentials.
25+
26+
2. Run the deployment script from the backend directory:
27+
`./deploy.sh`
28+
29+
The script will:
30+
- Login to Amazon ECR.
31+
- Build the Docker image for `linux/amd64`.
32+
- Push the image to ECR.
33+
- Trigger a service update on AWS App Runner.

.agent/workflows/extension.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
description: How to build and publish the verifyOS VS Code Extension
3+
---
4+
5+
// turbo-all
6+
# VS Code Extension Management Workflow
7+
8+
This workflow covers development and publishing for the verifyOS-vscode extension located in `editors/vscode`.
9+
10+
## Local Development
11+
12+
1. Navigate to the extension directory:
13+
`cd editors/vscode`
14+
15+
2. Install dependencies:
16+
`npm install`
17+
18+
3. Compile the extension:
19+
`npm run compile`
20+
21+
4. To test, open the directory in VS Code and press `F5` to launch the Extension Development Host.
22+
23+
## Packaging and Publishing
24+
25+
1. Packaging the extension (`.vsix`):
26+
`npm run package`
27+
28+
2. Publishing to VS Code Marketplace:
29+
`npm run publish:vsce`
30+
31+
3. Publishing to Open VSX:
32+
`npm run publish:ovsx`

.agent/workflows/frontend.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
description: How to manage and deploy the verifyOS-frontend (Web App)
3+
---
4+
5+
// turbo-all
6+
# Frontend Management Workflow
7+
8+
This workflow covers development and deployment for the verifyOS-frontend located in `apps/frontend`.
9+
10+
## Local Development
11+
12+
1. Navigate to the frontend directory:
13+
`cd apps/frontend`
14+
15+
2. Install dependencies (if needed):
16+
`npm install`
17+
18+
3. Run the development server:
19+
`npm run dev`
20+
21+
4. Access the app at `http://localhost:3000`.
22+
23+
## Deployment
24+
25+
The frontend is built as a standard Next.js application and is currently deployed to Vercel.
26+
27+
1. To create a production build:
28+
`npm run build`
29+
30+
2. To deploy, push changes to the `main` branch which triggers the Vercel integration, or use the Vercel CLI from `apps/frontend`:
31+
`vercel --prod`

0 commit comments

Comments
 (0)