Home

Awesome

award

🏆 award 是一个类似于 shields.io 的图标生成器,它可以用来表示一些「数据」和「链接」。

1 安装

1.1 裸机安装

首先你需要有 node.js 的开发环境,如果没有可以参考这个

# 克隆代码
git clone https://github.com/Ailln/award.git

cd award

# 安装依赖
npm install

# 本地运行
npm run dev

此时你可以尝试在浏览器中输入: http://127.0.0.1:3000?lt=🏆&rt=A.M%20Turing%20Award.,你将会得到这样一个图片:

当然你也可以像我一样,将它部署在服务器上 https://award.dovolopor.com?lt=🏆&rt=A.M%20Turing%20Award. 供给任何人使用。

1.2 容器安装

首先你需要安装 Docker,如果没有可以参考这个

# 克隆代码
git clone https://github.com/Ailln/award.git

cd award

# 构建
docker build -t award:1.1.0 .

# 运行
docker run -d --restart=always --name award -p 3000:3000 award:1.1.0

# 查看日志
docker logs -f award

2 使用

2.1 呈现「数据」

![](https://award.dovolopor.com?$parameters)

$parameters 为参数,和常见的 GET 请求参数一致。举个例子:lt=name&rt=Ailln

参数列表:

⚠️

  1. 如果想输入 空格,请用 %20 表示。
  2. 支持输入 emoji 表情。

2.2 呈现「数据」和「链接」

[![](https://award.dovolopor.com?$parameters)]($url)

$parameters 为参数,同上文。

$url 为跳转的链接,比如 https://github.com/Ailln/award

3 黎明之前的黑暗

细心的同学会发现,这个项目库里还有一个 archive 的文件夹,里面也包含里一份代码。它是我在这个想法上的第一次尝试,用了比较熟悉的 Python 语言开发,结果生成的图标非常模糊。于是就仔细研究里一下其他的项目,发现 javascript 语言更适合完成这个任务,于是就有了基于 express 的代码。

如果你对 PythonFlask 等技术很感兴趣,可以试着运行,使用方法如下:

cd award/archive

# 安装依赖
pip install -r requirements.txt -i https://pypi.douban.com/simple

# 运行
python server.py
# 在浏览器中打开 http://127.0.0.1:3001 即可看到效果

⚠️

  1. 代码仅支持 Python 3.6+
  2. 此版本的输入文本不支持 emoji 表情;
  3. 此版本代码仅支持 ltrt 两个参数。

4 后续计划

近期打算继续丰富 形状颜色字体 等功能,如果你又什么好想法可以提 Issue,我们一同探讨。

5 协议

⚠️ 不知道你有没有发现「👆这个图标」就是用本项目生成的。