Skip to content

Commit f1c9147

Browse files
author
janrozic1
committed
Add documentation for project setup and development
Create a replit.md file detailing the project's overview, structure, setup, and running instructions. Replit-Commit-Author: Agent Replit-Commit-Session-Id: dc672fdb-19d2-4d5f-bae1-94760b303a1d Replit-Commit-Checkpoint-Type: full_checkpoint Replit-Commit-Event-Id: d348c910-3467-43f6-b989-a881b6c6add0 Replit-Commit-Screenshot-Url: https://storage.googleapis.com/screenshot-production-us-central1/5ce4e9cd-2415-4003-8bb8-55c9c88cea00/dc672fdb-19d2-4d5f-bae1-94760b303a1d/1GeIdCE Replit-Helium-Checkpoint-Created: true
1 parent 8611e56 commit f1c9147

File tree

2 files changed

+50
-0
lines changed

2 files changed

+50
-0
lines changed

.replit

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,12 @@ outputType = "webview"
3232
[[ports]]
3333
localPort = 5000
3434
externalPort = 80
35+
36+
[[ports]]
37+
localPort = 42755
38+
externalPort = 3000
39+
40+
[deployment]
41+
deploymentTarget = "static"
42+
build = ["npm", "run", "build"]
43+
publicDir = "site/dist"

replit.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Ant Design Vue
2+
3+
## Overview
4+
This is the Ant Design Vue component library - an enterprise-class UI design language and Vue-based implementation. This repository contains both the component library source code and the documentation site.
5+
6+
## Project Structure
7+
- `components/` - Vue 3 component library source code
8+
- `site/` - Vite-powered documentation site
9+
- `scripts/` - Build and utility scripts
10+
- `plugin/` - Custom Vite plugins for documentation processing
11+
- `antd-tools/` - Build tooling for the component library
12+
13+
## Development Setup
14+
The project uses:
15+
- **Node.js 20** - JavaScript runtime
16+
- **Vite 3** - Development server and build tool
17+
- **Vue 3** - Frontend framework
18+
- **Less** - CSS preprocessing
19+
- **TypeScript** - Type-safe JavaScript
20+
21+
## Running the Project
22+
The dev server runs on port 5000:
23+
```bash
24+
npm run dev
25+
```
26+
27+
This starts the documentation site with hot reload for development.
28+
29+
## Key Scripts
30+
- `npm run dev` - Start development server
31+
- `npm run build` - Build the documentation site for production
32+
- `npm run compile` - Compile the component library
33+
- `npm run test` - Run tests
34+
35+
## Configuration
36+
- Vite config: `site/vite.config.ts`
37+
- TypeScript config: `tsconfig.json`
38+
- ESLint config: `.eslintrc.js`
39+
40+
## Recent Changes
41+
- December 2024: Configured for Replit environment with port 5000

0 commit comments

Comments
 (0)