Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kodie/stack-fanatic
A node module that uses Google's Puppeteer library to visit your Stack Overflow profile and check the progress of the badge you are currently tracking.
https://github.com/kodie/stack-fanatic
badge badges google node node-js node-module nodejs profile puppeteer stack-overflow stackexchange stackoverflow
Last synced: about 2 months ago
JSON representation
A node module that uses Google's Puppeteer library to visit your Stack Overflow profile and check the progress of the badge you are currently tracking.
- Host: GitHub
- URL: https://github.com/kodie/stack-fanatic
- Owner: kodie
- License: mit
- Created: 2019-07-03T16:20:09.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T19:53:39.000Z (about 2 years ago)
- Last Synced: 2024-11-18T16:30:52.103Z (about 2 months ago)
- Topics: badge, badges, google, node, node-js, node-module, nodejs, profile, puppeteer, stack-overflow, stackexchange, stackoverflow
- Language: JavaScript
- Size: 128 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# Stack Fanatic
[](https://www.npmjs.com/package/stack-fanatic)
[](https://travis-ci.org/kodie/stack-fanatic)
[](https://www.npmjs.com/package/stack-fanatic)
[](https://github.com/standard/standard)
[](license.md)
A node module that uses Google's [Puppeteer](https://pptr.dev/) library to visit your [Stack Overflow](https://stackoverflow.com/) profile and check the progress of the badge you are currently tracking.
## Installation
```shell
npm install stack-fanatic
```
## Usage
### Options
The following options can be passed to any functions (however none of them are required):
* **debug** - A boolean stating wether or not debugging information should be displayed in the console (Default: `false`)
* **loginEmail** - A string containing the email address asssociated with the StackOverflow account that you would like to log in to.
* **loginPassword** - A string containing the password for the StackOverflow account that you would like to log in to.
* **puppeteerOpts** - An object containing any options you wish to pass to the [puppeteer.launch()](https://pptr.dev/#?product=Puppeteer&version=v1.18.1&show=api-puppeteerlaunchoptions) function. (Sets the user agent to Google Chrome and the user data directory to `./userData` by default)
* **site** - A string containing the URL for the Stack Exchange site that you would like to pull badge info from. Should include the protocol at the beginning and no trailing slash. (Default: `https://stackoverflow.com`)
### check(options)
Visits your StackOverflow profile page and returns a promise that resolves with information about your tracked badge.
*Note: The `login` function will automatically be ran if `loginEmail` and `loginPassword` are passed as options and you are not currently logged in.*
```js
const stackFanatic = require('stack-fanatic')
stackFanatic
.check({
loginEmail: '[email protected]',
loginPassword: 'password1234',
site: 'https://stackoverflow.com'
})
.then(res => {
console.log('Badge Name:', res.badge)
console.log('Badge Type:', res.type)
console.log('Current Progress:', res.now)
console.log('Percent Completed:', res.percent)
})
.catch(err => {
console.log(err.message)
})
```
### Example Response
```js
{
badge: 'Fanatic',
max: 100,
min: 0,
now: 20,
percent: 20,
profile: 'https://stackoverflow.com/users/5463842/kodie-grantham',
type: 'Gold'
}
```
### login(options)
Logs into a StackOverflow account and returns a promise that resolves with `true` or `false` depending on if the login was successful or not.
*Note: After you are logged in, your session info will be saved in `./userData` so that you can run the `check` function without having to log in again.*
```js
const stackFanatic = require('stack-fanatic')
stackFanatic
.login({
loginEmail: '[email protected]',
loginPassword: 'password1234'
})
.then(loggedIn => {
if (loggedIn) {
console.log('Yay! You are logged in! :D')
} else {
console.log('Aw dang! You are not logged in. :(')
}
})
.catch(err => {
console.log(err.message)
})
```
## Tips/Tricks
### Check badge progress without logging in
Just set `site` to the URL of your Stack Overflow profile and make sure that you have `?tab=topactivity` at the end of it.
While you're at it, set Puppeteer's `userDataDir` option to `false` so that no session data or cache is saved.
```js
stackFanatic
.check({
site: 'https://stackoverflow.com/users/5463842/kodie-grantham?tab=topactivity',
puppeteerOpts: {
userDataDir: false
}
})
```
## Related
* [stack-fanatic-cli](https://github.com/kodie/stack-fanatic-cli) - The CLI tool for this module
## License
MIT. See the [LICENSE file](LICENSE.md) for more info.