skillhub/document/docs/01-getting-started/quick-start.md
2026-07-23 12:23:22 +08:00

85 lines
2 KiB
Markdown

---
title: Quick Start
sidebar_position: 2
description: One-click startup of SkillHub development environment
---
# Quick Start
## One-click Startup
Use the following command to start a complete SkillHub environment with one command:
```bash
curl -fsSL https://raw.githubusercontent.com/iflytek/skillhub/main/scripts/runtime.sh | sh -s -- up
```
Or clone the repository and start manually:
```bash
git clone https://github.com/iflytek/skillhub.git
cd skillhub
make dev-all
```
## Default Account
Both startup methods create a bootstrap admin account by default:
- username: `admin`
- password: `ChangeMe!2026`
### `curl` One-click Deployment
| Service | Address |
|---------|---------|
| Web UI | http://localhost |
| Backend API | http://localhost:8080 |
Log in with the default credentials above. **Change the password for production.**
### `make dev-all` Local Development
| Service | Address |
|---------|---------|
| Web UI | http://localhost:3000 |
| Backend API | http://localhost:8080 |
| MinIO Console | http://localhost:9001 |
In addition to the bootstrap admin, local development includes two mock users (no password needed):
| User | Role | Description |
|------|------|-------------|
| `local-user` | Regular user | Can publish skills, manage namespaces |
| `local-admin` | Super admin | Has all permissions including review and user management |
Use the `X-Mock-User-Id` request header to switch mock users.
To disable the bootstrap admin, set `BOOTSTRAP_ADMIN_ENABLED=false` before starting.
## Common Commands
```bash
# Start complete development environment
make dev-all
# Stop all services
make dev-all-down
# Reset and restart
make dev-all-reset
# Start backend only
make dev
# Start frontend only
make dev-web
# View all available commands
make help
```
## Next Steps
- [Overview](./overview) - Deep dive into product features
- [Use Cases](./use-cases) - Explore enterprise application scenarios
- [Single Machine Deployment](../administration/deployment/single-machine) - Production deployment guide