Skip to content

Commit 061962a

Browse files
authored
Update frontend/README.md (#1000)
1 parent c019bc8 commit 061962a

File tree

1 file changed

+36
-6
lines changed

1 file changed

+36
-6
lines changed

frontend/README.md

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,40 @@
1-
# React + TypeScript + Vite
1+
# Nebraska
22

3-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
3+
**Nebraska** is an update manager for [Flatcar Container Linux](https://www.flatcar.org/), built with **React**, **Vite**, and **MUI** (Material UI).
44

5-
Currently, two official plugins are available:
5+
## Features
66

7-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
8-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
7+
- ⚛️ React + Vite
8+
- 🎨 MUI (Material UI) for UI components
9+
- 🌐 i18n with i18next
10+
- 🧪 Testing with Vitest
11+
- 🧼 Linting & formatting via ESLint + Prettier
12+
- 📖 Storybook for isolated UI development
913

10-
## Expanding the ESLint configuration
14+
## Getting Started
15+
16+
```bash
17+
# Install dependencies
18+
npm install
19+
20+
# Start development server
21+
npm run dev
22+
23+
# Run tests
24+
npm test
25+
26+
# Run linter and formatter
27+
npm run lint
28+
npm run format
29+
30+
# Build for production
31+
npm run build
32+
33+
# Run Storybook
34+
npm run storybook
35+
36+
# Build Storybook
37+
npm run build-storybook
38+
39+
# Generate test coverage report
40+
npm run test:coverage

0 commit comments

Comments
 (0)