Skip to content

Commit f590322

Browse files
committed
📝 Update docs
1 parent a8234cd commit f590322

2 files changed

Lines changed: 9 additions & 36 deletions

File tree

development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ docker compose stop frontend
6363
And then start the local frontend development server:
6464

6565
```bash
66-
npm run dev
66+
bun run dev
6767
```
6868

6969
Or you could stop the `backend` Docker Compose service:

frontend/README.md

Lines changed: 8 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,15 @@
22

33
The frontend is built with [Vite](https://vitejs.dev/), [React](https://reactjs.org/), [TypeScript](https://www.typescriptlang.org/), [TanStack Query](https://tanstack.com/query), [TanStack Router](https://tanstack.com/router) and [Tailwind CSS](https://tailwindcss.com/).
44

5-
## Frontend development
5+
## Requirements
66

7-
Before you begin, ensure that you have either the Node Version Manager (nvm) or Fast Node Manager (fnm) installed on your system.
7+
- [Bun](https://bun.sh/) (recommended) or [Node.js](https://nodejs.org/)
88

9-
* To install fnm follow the [official fnm guide](https://github.com/Schniz/fnm#installation). If you prefer nvm, you can install it using the [official nvm guide](https://github.com/nvm-sh/nvm#installing-and-updating).
10-
11-
* After installing either nvm or fnm, proceed to the `frontend` directory:
12-
13-
```bash
14-
# If using fnm
15-
fnm install
16-
17-
# If using nvm
18-
nvm install
19-
```
20-
21-
* Once the installation is complete, switch to the installed version:
22-
23-
```bash
24-
# If using fnm
25-
fnm use
26-
27-
# If using nvm
28-
nvm use
29-
```
30-
31-
* Within the `frontend` directory, install the necessary NPM packages:
32-
33-
```bash
34-
npm install
35-
```
36-
37-
* And start the live server with the following `npm` script:
9+
## Quick Start
3810

3911
```bash
40-
npm run dev
12+
bun install
13+
bun run dev
4114
```
4215

4316
* Then open your browser at http://localhost:5173/.
@@ -89,7 +62,7 @@ But it would be only to clean them up, leaving them won't really have any effect
8962
* To generate the frontend client, run:
9063

9164
```bash
92-
npm run generate-client
65+
bun run generate-client
9366
```
9467

9568
* Commit the changes.
@@ -128,13 +101,13 @@ docker compose up -d --wait backend
128101
Then, you can run the tests with the following command:
129102

130103
```bash
131-
npx playwright test
104+
bunx playwright test
132105
```
133106

134107
You can also run your tests in UI mode to see the browser and interact with it running:
135108

136109
```bash
137-
npx playwright test --ui
110+
bunx playwright test --ui
138111
```
139112

140113
To stop and remove the Docker Compose stack and clean the data created in tests, use the following command:

0 commit comments

Comments
 (0)