Skip to content

Commit 0d34ace

Browse files
committed
readme
1 parent a1d9060 commit 0d34ace

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Main project folder for the frontend React application.
88

99
#### 📁 node_modules/
1010

11-
Contains all installed npm packages and dependencies. Managed automatically by npm/yarn.
11+
Contains all installed packages and dependencies. Managed automatically by Bun.
1212

1313
#### 📁 public/
1414

@@ -94,9 +94,9 @@ Visual map/diagram of the frontend structure.
9494

9595
Main HTML file loaded by Vite. Contains root div for React.
9696

97-
#### package-lock.json / package.json
97+
#### bun.lock / package.json
9898

99-
NPM package management files. List dependencies, scripts, and project metadata.
99+
Bun package management files. List dependencies, scripts, and project metadata.
100100

101101
## folder structure
102102

@@ -177,7 +177,7 @@ NPM package management files. List dependencies, scripts, and project metadata.
177177
├── 📄 eslint.config.js
178178
├── 📄 frontend_map.pdf
179179
├── 📄 index.html
180-
├── 📄 package-lock.json
180+
├── 📄 bun.lock
181181
├── 📄 package.json
182182
├── 📄 README.md
183183
└── 📄 vite.config.js
@@ -287,9 +287,13 @@ backend/
287287

288288
### 7. Development & Contribution
289289

290-
- Run `npm install` to install dependencies.
291-
- Use `npm run dev` to start the development server.
292-
- Lint code with `npm run lint`.
290+
- Run `bun install` to install dependencies.
291+
- Use `bun run dev` to start the development server.
292+
- Lint code with `bun run lint`.
293+
294+
## CI
295+
296+
GitHub Actions runs a Bun-based pipeline to install, lint, test (backend), and build (frontend) on pushes and pull requests.
293297
- Follow the folder structure and naming conventions for new components/pages.
294298

295299
---

0 commit comments

Comments
 (0)