47 lines
1.2 KiB
Markdown
47 lines
1.2 KiB
Markdown
# Bonch Material You Client
|
|
|
|
A modern Material You (Material 3) client for the `bonch-open-api`.
|
|
|
|
## Features
|
|
- **Material 3 Design:** Clean UI following Material You principles with support for light/dark modes.
|
|
- **Dynamic API Configuration:** Easily switch API domains and keys.
|
|
- **Profile View:** View student profile information (Full Name, Group, Faculty, Email).
|
|
- **Responsive:** Works well on mobile and desktop.
|
|
|
|
## Stack
|
|
- **Frontend:** React + TypeScript + Vite
|
|
- **State Management:** Zustand (with persistence)
|
|
- **API Client:** Axios
|
|
- **Icons:** Lucide React
|
|
- **Routing:** React Router DOM
|
|
|
|
## Getting Started
|
|
|
|
1. **Clone the repository**
|
|
```bash
|
|
git clone https://gitea.snusxd.site/adminxd/bonch-md-client.git
|
|
cd bonch-md-client
|
|
```
|
|
|
|
2. **Setup environment**
|
|
Copy `.env.example` to `.env` and set your default API domain.
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
|
|
3. **Install dependencies**
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
4. **Run development server**
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
## Configuration
|
|
The API domain can be configured via the `VITE_API_DOMAIN` environment variable or changed directly in the app's login screen.
|
|
|
|
## License
|
|
Private
|