Skip to content

Commit 23ce95f

Browse files
committed
clean readme, add developing doc
1 parent d98b411 commit 23ce95f

File tree

2 files changed

+34
-36
lines changed

2 files changed

+34
-36
lines changed

ui/DEVELOPING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## Getting Started
2+
3+
First, run the development server:
4+
5+
```bash
6+
npm run dev
7+
```
8+
9+
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
10+
11+
#### `npm run build`
12+
13+
Builds the app for production to the `out` folder.\
14+
15+
#### `make test-unit`
16+
17+
Run unit test once on your local terminal.
18+
19+
#### `make test-integration`
20+
21+
Run integration test once on your local terminal.
22+
23+
#### `npx cypress run --headless`
24+
25+
Run end to end tests against localhost:3000
26+
27+
#### `make style`
28+
29+
Fix code styling issues.
30+
31+
#### `make quality`
32+
33+
Run quality eslint quality checks.

ui/README.md

Lines changed: 1 addition & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1 @@
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).
2-
3-
## Getting Started
4-
5-
First, run the development server:
6-
7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
15-
```
16-
17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
18-
19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
20-
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.
22-
23-
## Learn More
24-
25-
To learn more about Next.js, take a look at the following resources:
26-
27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [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.
1+
# GuideLLM UI

0 commit comments

Comments
 (0)