2.3 KiB
2.3 KiB
Attune Web UI - Quick Start Guide
Get the Attune Web UI running in 5 minutes.
Prerequisites
- Node.js 18+ installed
- Attune API service running (see main README)
Quick Start
# 1. Install dependencies
cd web
npm install
# 2. Start development server
npm run dev
The UI will be available at http://localhost:3000
First Login
The web UI connects to the API service at http://localhost:8080 by default.
- Open http://localhost:3000
- You'll be redirected to the login page
- Enter credentials from your Attune installation
- After login, you'll see the dashboard
Default Test Credentials
If using the development database with seed data:
- Username:
admin - Password: (depends on your setup)
Configuration
The web UI is configured via environment variables:
VITE_API_BASE_URL=http://localhost:8080 # API service URL
VITE_WS_URL=ws://localhost:8081 # WebSocket URL (future)
To customize, create .env.development.local:
cp .env.development .env.development.local
# Edit values as needed
Common Tasks
Build for Production
npm run build
Output will be in dist/ directory.
Preview Production Build
npm run preview
Generate API Client
When the API changes, regenerate the client:
npm run generate:api
This requires the API service to be running.
Troubleshooting
"Connection refused" errors
Ensure the API service is running:
cd ..
make dev # or your preferred method to start services
Login fails
Check that:
- API service is running on port 8080
- Database is migrated
- User exists in the database
Build errors
Clear cache and rebuild:
rm -rf node_modules/.tmp
npm run build
Development
- Hot Reload: Changes to files automatically reload
- TypeScript: Full type checking during development
- Linting: Run
npm run lintto check code
Next Steps
- Read the full README.md for detailed documentation
- Review Web UI Architecture
- Check TODO for planned features
Need Help?
- Check logs in browser DevTools Console
- Review API responses in Network tab
- See Troubleshooting in README