https://github.com/znitche/piscanui
React frontend for piScan system
https://github.com/znitche/piscanui
lightweight react typescript wouter
Last synced: 12 months ago
JSON representation
React frontend for piScan system
- Host: GitHub
- URL: https://github.com/znitche/piscanui
- Owner: zNitche
- License: mit
- Created: 2024-01-26T19:46:01.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-19T18:41:44.000Z (almost 2 years ago)
- Last Synced: 2025-01-29T12:21:08.909Z (about 1 year ago)
- Topics: lightweight, react, typescript, wouter
- Language: TypeScript
- Homepage:
- Size: 410 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## piScanUI
Web UI for [piScan](https://github.com/zNitche/piScan) system.
---
### Technologies
- React 18.2
- Vite 5.1.4
- Typescript 5.2.2
- wouter 3.0.1
- nginx
### Features
- Scanning devices (scanners / printers) management
- Inifinite scroll for files preview + search support
- Starting + monitoring scanning processes
- Integrated with eslint and prettier
### Setup
#### Dev
1. Create `.env` file
```
cp .env.template .env
```
2. Set `VITE_API_URL` to API url, for example
```
http://127.0.0.1:8000/api
```
3. Install dependencies
```
npm i
```
4. Start dev server
```
npm run dev
```
#### Production
1. Create `.env` file
```
cp .env.template .env
```
2. Set `VITE_API_URL` to API url, for example
```
http://127.0.0.1:8000/api
```
3. Build docker image
```
docker compose build
```
4. Serve app via nginx
```
docker compose up -d
```