Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lete114/visitor-badge
A badge generator service to count visitors of your markdown file.
https://github.com/lete114/visitor-badge
badge deta free mongodb redis visitor visitor-badge
Last synced: 2 months ago
JSON representation
A badge generator service to count visitors of your markdown file.
- Host: GitHub
- URL: https://github.com/lete114/visitor-badge
- Owner: Lete114
- License: mit
- Created: 2022-06-30T14:14:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-08T03:57:43.000Z (4 months ago)
- Last Synced: 2024-10-08T10:11:14.836Z (3 months ago)
- Topics: badge, deta, free, mongodb, redis, visitor, visitor-badge
- Language: HTML
- Homepage: https://visitor-badge.imlete.cn
- Size: 215 KB
- Stars: 15
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# visitor-badge
> **Warning** Since `Deta` will abandon Deta Cloud and move to Deta Space, the deta.dev domain is temporarily closed to users, please change `visitor_badge.deta.dev` to `visitor-badge.imlete.cn`
> **The example service is currently deployed on the free version of [Deta](https://deta.space), You can visit the [/list](https://visitor-badge.imlete.cn/list) path to see all the statistics**
Inspired by [jwenjian/visitor-badge](https://github.com/jwenjian/visitor-badge) written in `Python` (PV stats only)
## Function
- PV (Number of visits)
- UV (Number of visitors)
- Multi-database selection (mongodb, redis, deta)
## Deployment
### Deta Free
[](https://deta.space/discovery/@leter/visitorbadge)
### Server
```bash
git clone https://github.com/Lete114/visitor-badge.git visitor-badge
cd visitor-badge
npm run start
```
### ServerLess
See the other branches of the repository for details
### Configuration Database
Rename the `.env.example` file to `.env` and edit it (just fill in the comments according to the file)
### Use
```markdown
```
> where `id` is custom and it is not constrained in any way.
>
> Here are some suggestions
>
> 1. Specify a user's home page, e.g.: https://github.com/Lete114 using `id=github.lete114`
> 2. Specify a user's repository, e.g.: https://github.com/Lete114/visitor-badge using `id=github.lete114.visitor-badge`
> 3. Specify the issues in a user's repository, e.g.: https://github.com/Lete114/visitor-badge/issues/1 using `id=github.lete114.visitor-badge.issues.1`
> 4. Specify a website, e.g.: https://blog.imlete.cn using `id=blog.imlete.cn`
> 5. Specify a page of a website, e.g.: https://blog.imlete.cn/404.html using `id=blog.imlete.cn.404`
| Key | Default | Required | Options | Description |
| ---------- | -------- | -------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| id | | ✅ | | Page unique ID |
| type | pv | | ['pv', 'uv'] | Statistics type |
| label | visitors | | | Custom label (left) name |
| labelColor | 555 | | | Custom label (left) color (Note: You can leave out the well number `#`) |
| color | 4c1 | | | Custom stats (right side) color (Note: You can leave out the well number `#`) |
| style | flat | | ['plastic', 'flat', 'flat-square', 'for-the-badge', 'social'] | Custom badge style |