vue-color-avatar/README.md

75 lines
1.7 KiB
Markdown
Raw Normal View History

2021-10-16 10:29:32 +00:00
<div align="center">
<h1>Vue Color Avatar</h1>
2022-09-18 13:48:28 +00:00
<p>🧑‍🦱 A playful avatar generator 🧑‍🦳</p>
2021-10-16 10:29:32 +00:00
2022-09-18 13:48:28 +00:00
[简体中文](./README-CN.md)
2021-10-16 10:29:32 +00:00
</div>
2022-09-18 13:48:28 +00:00
<a href="https://vue-color-avatar.vercel.app">
<img src="./images/social-preview-1.png" alt="website-cover" />
2021-12-10 15:52:23 +00:00
</a>
2021-10-21 15:20:47 +00:00
2021-10-16 10:29:32 +00:00
## Preview
[`https://vue-color-avatar.vercel.app`](https://vue-color-avatar.vercel.app)
## Introduction
2022-09-18 13:48:28 +00:00
**This is a vector style avatar generator, you can match different material components to generate your own personalized avatar.**
2021-10-21 15:20:47 +00:00
Features you might be interested in:
- Visual component configuration bar
- Randomly generate an avatar
- Redo/Undo
- i18n
2022-07-28 05:21:17 +00:00
- Generate multiple avatars in batch
2021-10-16 10:29:32 +00:00
## Assets
2022-09-18 13:54:26 +00:00
> **Note**
2022-09-18 13:48:28 +00:00
> 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/).
2021-10-16 10:29:32 +00:00
## Develop
2022-09-18 13:48:28 +00:00
This project is built with `Vue3` + `Vite`.
2021-10-16 10:29:32 +00:00
```sh
# 1. Clone project
git clone https://github.com/Codennnn/vue-color-avatar.git
# 2. Install dependencies
yarn install
# 3. Run
yarn dev
```
2023-04-12 07:05:16 +00:00
## Docker deploy
You can directly run using the image I have already built.
```sh
2023-08-18 03:19:10 +00:00
docker run -d -t -p 5173:5173 \
--name=vue-color-avatar \
--restart=always \
docker.io/wenyang0/vue-color-avatar:latest
2023-04-12 07:05:16 +00:00
```
Or, you can manually compile it yourself if you prefer.
```sh
#clone the code
2023-04-12 07:10:55 +00:00
git clone https://github.com/Codennnn/vue-color-avatar.git
2023-04-12 07:05:16 +00:00
#docker build
cd vue-color-avatar/
docker build -t vue-color-avatar:v1 .
2023-04-12 07:20:23 +00:00
#start server
2023-04-12 07:18:29 +00:00
docker run -d -t -p 5173:5173 --name vue-color-avatar --restart=always vue-color-avatar:v1
2023-04-12 07:05:16 +00:00
```
Finally, open your browser and access the service's address at http://serverIP:5173