https://github.com/m4cs/signmyprofile
Source Code for SignMyProfile
https://github.com/m4cs/signmyprofile
Last synced: 3 months ago
JSON representation
Source Code for SignMyProfile
- Host: GitHub
- URL: https://github.com/m4cs/signmyprofile
- Owner: M4cs
- Created: 2020-08-30T06:49:12.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-09-01T05:24:42.000Z (almost 5 years ago)
- Last Synced: 2025-02-17T21:13:34.481Z (4 months ago)
- Language: Python
- Size: 49.8 KB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SignMyProfile
Source Code for SignMyProfile
# How to Use
You can get a custom badge for your GitHub README from shields.io that displays how many people have signed your profile. You also get to see who has on the SignMyProfile homepage!
[Visit the SignMyProfile homepage here](https://smp.maxbridgland.com)
How the badge works:
Example
[](https://smp.maxbridgland.com/sign/34947910)
```
[](https://smp.maxbridgland.com/sign/GITHUB USER ID)
```
You can go to https://smp.maxbridgland.com/ to get your badge!
This uses Login with Github to get your Username, Avatar, and Display Name. It will use GitHub to authenticate and an OAuth2 token with **ONLY** user:read scope is generated. The tokens generated from SMP cannot modify/delete any data on your profile!
# Development
- Python 3.6+
- Flask
- MongoDB
Requires a `config.json` file in the root directory:
```json
{
"MONGO_URI": "",
"GH_CLIENT_ID": "",
"GH_SECRET_KEY": ""
}
```
Self-explainatory