Skip to content

Commit b51edc7

Browse files
committed
docs: add backend and frontend start steps
1 parent 0d611c8 commit b51edc7

2 files changed

Lines changed: 34 additions & 19 deletions

File tree

apps/backend/README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,24 @@
22

33
This service provides a clean, versioned HTTP API that accepts an `.ipa` or `.app` upload and returns a normalized scan report.
44

5+
## Quick Start
6+
7+
From the repo root:
8+
9+
```bash
10+
cargo run --manifest-path apps/backend/Cargo.toml
11+
```
12+
13+
The API listens on `http://127.0.0.1:7070` by default.
14+
15+
Example request:
16+
17+
```bash
18+
curl -X POST http://127.0.0.1:7070/api/v1/scan \
19+
-F "bundle=@/path/to/YourApp.ipa" \
20+
-F "profile=full"
21+
```
22+
523
## API
624

725
`POST /api/v1/scan`
@@ -13,5 +31,5 @@ Response: JSON report (same shape as `voc --format json`).
1331

1432
## Notes
1533

16-
- This module depends on the root `verifyos-cli` crate.
34+
- This module depends on the root `verifyOS` crate (`verifyos-cli`).
1735
- It is initialized as a standalone crate for a future Cargo workspace split.

apps/frontend/README.md

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,33 @@
1-
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
1+
This is the verifyOS web frontend (Next.js). It provides a clean UI to upload an `.ipa` or `.app` and shows scan results from the backend API.
22

33
## Getting Started
44

5-
First, run the development server:
5+
Install dependencies and start the dev server:
66

77
```bash
8+
cd apps/frontend
9+
npm install
810
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
1511
```
1612

1713
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
1814

19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
15+
To run the backend in another terminal:
2016

21-
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
17+
```bash
18+
cargo run --manifest-path apps/backend/Cargo.toml
19+
```
20+
21+
The UI expects the backend at `http://127.0.0.1:7070` unless otherwise configured.
22+
23+
## Development Notes
24+
25+
- Main UI: `app/page.tsx`
26+
- API integration: `app/api` or client hooks when added
2227

2328
## Learn More
2429

2530
To learn more about Next.js, take a look at the following resources:
2631

2732
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
2833
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
29-
30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
31-
32-
## Deploy on Vercel
33-
34-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
35-
36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.

0 commit comments

Comments
 (0)