Skip to content

Commit

Permalink
config: 修改 README.md 中英文调换
Browse files Browse the repository at this point in the history
  • Loading branch information
kangood committed Feb 5, 2024
1 parent a81434a commit d1b8887
Show file tree
Hide file tree
Showing 3 changed files with 178 additions and 178 deletions.
116 changes: 116 additions & 0 deletions README.en-US.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
<div align="center">
<br>
<br>
<h1>Slash Admin
</h1>
</div>

**English** | [中文](./README.zh-CN.md)

## Introduction
Slash Admin is a modern admin dashboard template built with React 18, Vite, Ant Design, and TypeScript. It is designed to help developers quickly create powerful admin management systems.

## Preview
+ https://admin.slashspaces.com/

![login.png](https://d3george.github.io/github-static/slash-admin/login.jpeg)
![login_dark.png](https://d3george.github.io/github-static/slash-admin/login_dark.jpeg)
![analysis.png](https://d3george.github.io/github-static/slash-admin/analysis.png)
![workbench.png](https://d3george.github.io/github-static/slash-admin/workbench.png)

## Features

- Built using React 18 hooks.
- Powered by Vite for rapid development and hot module replacement.
- Integrates Ant Design, providing a rich set of UI components and design patterns.
- Written in TypeScript, offering type safety and an improved development experience.
- Responsive design, adapting to various screen sizes and devices.
- Flexible routing configuration, supporting nested routes.
- Integrated access control based on user roles.
- Supports internationalization for easy language switching.
- Includes common admin features like user management, role management, and permission management.
- Customizable themes and styles to meet your branding needs.
- Mocking solution based on MSW and Faker.js.
- State management using Zustand.
- Data fetching using React-Query.

## Quick Start

### Get the Project Code

```bash
git clone https://github.com/d3george/slash-admin.git
```

### Install Dependencies

In the project's root directory, run the following command to install project dependencies:

```bash
pnpm install
```

### Start the Development Server

Run the following command to start the development server:

```bash
pnpm dev
```

Visit [http://localhost:3001](http://localhost:3001) to view your application.

### Build for Production

Run the following command to build the production version:

```bash
pnpm build
```

## Docker deployment


### Build image and Run container
#### build image
Enter the project root directory in the terminal and execute the following command to build the Docker image:
```
docker build -t your-image-name .
```
Make sure to replace `your-image-name` with your own image name

#### run container
Run your application in the Docker container using the following command:
```
docker run -p 3001:80 your-image-name
```
This will run your application on port `80`(exposed in `Dockerfile`) of the container and map it to port `3001` on your host.

Now you can access http://localhost:3001 to view the deployed applications.

### use docker-compose.yaml
Enter the project root directory in the terminal and execute the following command to start Docker Compose:
```
docker-compose up -d
```
Docker Compose will build an image based on the configuration defined by 'docker-compose. yaml' and run the container in the background.

After the container runs successfully, it can also be accessed through http://localhost:3001 To view the deployed applications.


## Git Contribution submission specification

reference[.commitlint.config.js](./commitlint.config.js)

- `feat` new features
- `fix` fix the
- `docs` documentation or comments
- `style` code format (changes that do not affect code execution)
- `refactor` refactor
- `perf` performance optimization
- `revert` revert commit
- `test` test related
- `chore` changes in the construction process or auxiliary tools
- `ci` modify CI configuration and scripts
- `types` type definition file changes
- `wip` in development
125 changes: 62 additions & 63 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,112 +5,111 @@
</h1>
</div>

**English** | [中文](./README.zh-CN.md)
**中文** | [English](./README.en-US.md)

## Introduction
Slash Admin is a modern admin dashboard template built with React 18, Vite, Ant Design, and TypeScript. It is designed to help developers quickly create powerful admin management systems.
## 简介

## Preview
Slash Admin 是一个现代化的后台管理模板,基于 React 18、Vite、Ant Design 和 TypeScript 构建。它旨在帮助开发人员快速搭建功能强大的后台管理系统。

## 预览
+ https://admin.slashspaces.com/

![login.png](https://d3george.github.io/github-static/slash-admin/login.jpeg)
![login_dark.png](https://d3george.github.io/github-static/slash-admin/login_dark.jpeg)
![analysis.png](https://d3george.github.io/github-static/slash-admin/analysis.png)
![workbench.png](https://d3george.github.io/github-static/slash-admin/workbench.png)

## Features

- Built using React 18 hooks.
- Powered by Vite for rapid development and hot module replacement.
- Integrates Ant Design, providing a rich set of UI components and design patterns.
- Written in TypeScript, offering type safety and an improved development experience.
- Responsive design, adapting to various screen sizes and devices.
- Flexible routing configuration, supporting nested routes.
- Integrated access control based on user roles.
- Supports internationalization for easy language switching.
- Includes common admin features like user management, role management, and permission management.
- Customizable themes and styles to meet your branding needs.
- Mocking solution based on MSW and Faker.js.
- State management using Zustand.
- Data fetching using React-Query.

## Quick Start

### Get the Project Code
## 特性

- 使用 React 18 hooks 进行构建。
- 基于 Vite 进行快速开发和热模块替换。
- 集成 Ant Design,提供丰富的 UI 组件和设计模式。
- 使用 TypeScript 编写,提供类型安全性和更好的开发体验。
- 响应式设计,适应各种屏幕尺寸和设备。
- 灵活的路由配置,支持多级嵌套路由。
- 集成权限管理,根据用户角色控制页面访问权限。
- 集成国际化支持,轻松切换多语言。
- 集成常见的后台管理功能,如用户管理、角色管理、权限管理等。
- 可定制的主题和样式,以满足您的品牌需求。
- 基于 MSW 和 Faker.js 的Mock方案
- 使用 Zustand 进行状态管理
- 使用 React-Query 进行数据获取

## 快速开始

### 获取项目代码

```bash
git clone https://github.com/d3george/slash-admin.git
```

### Install Dependencies
### 安装依赖

In the project's root directory, run the following command to install project dependencies:
在项目根目录下运行以下命令安装项目依赖:

```bash
pnpm install
```

### Start the Development Server
### 启动开发服务器

Run the following command to start the development server:
运行以下命令以启动开发服务器:

```bash
pnpm dev
```

Visit [http://localhost:3001](http://localhost:3001) to view your application.
访问 [http://localhost:3001](http://localhost:3001) 查看您的应用程序。

### Build for Production
### 构建生产版本

Run the following command to build the production version:
运行以下命令以构建生产版本:

```bash
pnpm build
```

## Docker deployment
构建后的文件将位于 `dist` 目录中。

## 容器化部署

### Build image and Run container
#### build image
Enter the project root directory in the terminal and execute the following command to build the Docker image:
### 构建镜像并运行容器
#### 构建镜像
在终端中进入项目根目录,并执行以下命令来构建 Docker 镜像:
```
docker build -t your-image-name .
```
Make sure to replace `your-image-name` with your own image name
确保将 `your-image-name` 替换为你自己的镜像名称

#### run container
Run your application in the Docker container using the following command:
#### 运行容器
使用以下命令在 Docker 容器中运行你的应用:
```
docker run -p 3001:80 your-image-name
```
This will run your application on port `80`(exposed in `Dockerfile`) of the container and map it to port `3001` on your host.
这将在容器的端口 `80` (暴露在`Dockerfile`中) 上运行你的应用,并将其映射到你主机的端口 `3001` 上。

现在,你可以通过访问 http://localhost:3001 来查看部署的应用。

Now you can access http://localhost:3001 to view the deployed applications.

### use docker-compose.yaml
Enter the project root directory in the terminal and execute the following command to start Docker Compose:
### 使用docker-compose.yaml
在终端中进入项目根目录,并执行以下命令来启动 Docker Compose
```
docker-compose up -d
```
Docker Compose will build an image based on the configuration defined by 'docker-compose. yaml' and run the container in the background.

After the container runs successfully, it can also be accessed through http://localhost:3001 To view the deployed applications.


## Git Contribution submission specification

reference[.commitlint.config.js](./commitlint.config.js)

- `feat` new features
- `fix` fix the
- `docs` documentation or comments
- `style` code format (changes that do not affect code execution)
- `refactor` refactor
- `perf` performance optimization
- `revert` revert commit
- `test` test related
- `chore` changes in the construction process or auxiliary tools
- `ci` modify CI configuration and scripts
- `types` type definition file changes
- `wip` in development
Docker Compose 根据`docker-compose.yaml`定义的配置构建镜像并在后台运行容器.

容器运行成功后,同样可以通过访问 http://localhost:3001来查看部署的应用。

参考[.commitlint.config.js](./commitlint.config.js)

- `feat` 新功能
- `fix` 修复bug
- `docs` 文档注释
- `style` 代码格式(不影响代码运行的变动)
- `refactor` 重构
- `perf` 性能优化
- `revert` 回滚commit
- `test` 测试相关
- `chore` 构建过程或辅助工具的变动
- `ci` 修改CI配置、脚本
- `types` 类型定义文件修改
- `wip` 开发中
Loading

0 comments on commit d1b8887

Please sign in to comment.