diff --git a/README.md b/README.md index 4fba606..dab6568 100644 --- a/README.md +++ b/README.md @@ -7,31 +7,42 @@

- Counter + Counter
+* 上方的计数器为不更新版本只保留了最基本的功能 + ## Python 版访问次数计数器使用了flask 作为服务端接收请求 -* [文档](https://request-counter-docs.vercel.app/#/) + +* [文档](https://request-counter-docs.vercel.app/#/) + ### 开源 + - 本项目以[Apache-2.0](./LICENSE)许可开源, 即: - - 你可以直接使用该项目提供的功能, 无需任何授权 - - 你可以在**注明来源版权信息**的情况下对源代码进行任意分发和修改以及衍生 - + - 你可以直接使用该项目提供的功能, 无需任何授权 + - 你可以在**注明来源版权信息**的情况下对源代码进行任意分发和修改以及衍生 + ## 部署 + +> 在部署之前你需要先安装`python3.10.x`以上的版本 + ### 已部署好的地址 -* https://requestcounter.herokuapp.com/get?name=MarkusJoe + +* [Click to enter](https://requestcounter.herokuapp.com/get/MarkusJoe) * 默认主题: `lewd` - ### 部署到Heroku -1. `fork` 本项目到你的仓库 -2. 在[Heroku](https://www.heroku.com/) 注册账号 -3. 在[Dashboard](https://dashboard.heroku.com/apps) 新建App -4. 流程: 进入网址 -> 点击右上角`New` -> 点击 `Create new app` -> 输入App名称 -> `Create app` -> 选择`Github` (登陆完成后) -> 点击`Search` -> 选择你fork的项目并点击`Connect` -> 滑到末尾点击`Deploy branch`(如果你想在仓库更新时自动部署的话可以把`Enable Automatic Deploy`勾选) -> 等待完成 -5. App的地址就是 `App名称` + `.herokuapp.com` -> 在部署之前你需要先安装`python3.10.x`以上的版本 +1. `fork` 本项目到你的仓库 +2. 此步骤为 `非必要` 你可以在 `fork` 本仓库到你的仓库时, 修改 `./bin/conf/config.yml` 内的配置文件来修改配置 (前提时你的仓库为私人仓库, 否则可能泄露一些私人信息) +3. 在[Heroku](https://www.heroku.com/) 注册账号 +4. 在[Dashboard](https://dashboard.heroku.com/apps) 新建App +5. 流程: 进入网址 -> 点击右上角`New` -> 点击 `Create new app` -> 输入App名称 -> `Create app` -> 选择`Github` (登陆完成后) -> 点击`Search` -> + 选择你fork的项目并点击`Connect` -> 滑到末尾点击`Deploy branch`(如果你想在仓库更新时自动部署的话可以把`Enable Automatic Deploy`勾选) -> 等待完成 +6. App的地址就是 `App名称` + `.herokuapp.com` + ### 部署到本地服务器 + ```shell $ git clone https://github.com/MarkusJoe/RequestCounter.git $ cd RequestCounter @@ -40,12 +51,13 @@ ``` ## 调用须知 + - API支持`GET` 和 `POST` 方法请求 - 最大可以计数`10`位数, 超过则重置 - 可以自定义显示位数默认`7`位数最大`10`位 - 可以自己选择更多的主题只需要加上请求参数: `theme` 再加上想要的主题即可 - 在`theme`请求参数中写入`ls`可以获取所有可选的主题 (来自于`./bin/assets/theme.db`) - # 一些信息 + - 使用了Python3.6 的标准库`Sqlite3`进行数据库操作