mirror of
https://github.com/Codennnn/vue-color-avatar.git
synced 2024-10-18 12:28:04 +00:00
72 lines
1.7 KiB
Markdown
72 lines
1.7 KiB
Markdown
<div align="center">
|
|
<h1>Vue Color Avatar</h1>
|
|
|
|
<p>🧑🦱 A playful avatar generator 🧑🦳</p>
|
|
|
|
[简体中文](./README-CN.md)
|
|
|
|
</div>
|
|
|
|
<a href="https://vue-color-avatar.vercel.app">
|
|
<img src="./images/social-preview-1.png" alt="website-cover" />
|
|
</a>
|
|
|
|
## Preview
|
|
|
|
[`https://vue-color-avatar.vercel.app`](https://vue-color-avatar.vercel.app)
|
|
|
|
## Introduction
|
|
|
|
**This is a vector style avatar generator, you can match different material components to generate your own personalized avatar.**
|
|
|
|
Features you might be interested in:
|
|
|
|
- Visual component configuration bar
|
|
- Randomly generate an avatar
|
|
- Redo/Undo
|
|
- i18n
|
|
- Generate multiple avatars in batch
|
|
|
|
## Assets
|
|
|
|
> **Note**
|
|
> The avatar assets implementation of [Avatar Illustration System](https://www.figma.com/community/file/829741575478342595) by Micah Lanier. And the licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).
|
|
|
|
## Develop
|
|
|
|
This project is built with `Vue3` + `Vite`.
|
|
|
|
```sh
|
|
# 1. Clone project
|
|
git clone https://github.com/Codennnn/vue-color-avatar.git
|
|
|
|
# 2. Install dependencies
|
|
yarn install
|
|
|
|
# 3. Run
|
|
yarn dev
|
|
```
|
|
|
|
## Docker deploy
|
|
|
|
You can directly run using the image I have already built.
|
|
```sh
|
|
#docker run
|
|
docker run -d -t -p 5173:5173 --name vue-color-avatar --restart=always docker.io/wenyang0/vue-color-avatar:latest
|
|
```
|
|
|
|
Or, you can manually compile it yourself if you prefer.
|
|
|
|
```sh
|
|
#clone the code
|
|
git clone https://github.com/Codennnn/vue-color-avatar.git
|
|
|
|
#docker build
|
|
cd vue-color-avatar/
|
|
docker build -t vue-color-avatar:v1 .
|
|
|
|
#docker run
|
|
docker run -d -t -p 5173:5173 --name vue-color-avatar --restart=always vue-color-avatar:v1
|
|
```
|
|
Finally, open your browser and access the service's address at http://serverIP:5173
|