Skip to content

Commit

Permalink
url with no path redirect to github page
Browse files Browse the repository at this point in the history
  • Loading branch information
Matheus Cesar C. - Matsukii committed Oct 4, 2019
1 parent 13a75b7 commit f79b2cd
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 12 deletions.
41 changes: 29 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@ A set of useful apis
# General usage

## Og tag getter
https://polarpod.herokuapp.com/apis/ogtags?u=[URL]<br><br>

```
https://polarpod.herokuapp.com/apis/ogtags?u=[URL]
```

parameters:<br>
* u: url<br>
Expand All @@ -32,7 +35,11 @@ response:<br>


## SVG QR Code generator
https://polarpod.herokuapp.com/apis/qr?u=[URL]&d=[true]/[false]&w=[width]&c=[color]&bg=[background]<br><br>

```
https://polarpod.herokuapp.com/apis/qr?u=[URL]&d=[true]/[false]&w=[width]&c=[color]&bg=[background]
```

parameters:<br>
* u: data<br>
* d: dark/light [true/false] (if true generates a lighet qr)<br>
Expand All @@ -46,15 +53,23 @@ response:<br>


## Video URL parser
http://polarpod.herokuapp.com/apis/vidurl?u=[URL]<br>

```
http://polarpod.herokuapp.com/apis/vidurl?u=[URL]
```

params:<br>
* u: video url

response:<br>
* json

## Bad-word message filter
https://polarpod.herokuapp.com/apis/filter?msg=[message_to_filter]<br><br>

```
https://polarpod.herokuapp.com/apis/filter?msg=[message_to_filter]
```

params:<br>
* msg: message

Expand Down Expand Up @@ -91,17 +106,19 @@ response:<br>
}
```

## Modules credits

# Modules credits
[qrcode-svg by papnkukn](https://github.com/papnkukn/qrcode-svg)<br>
[bad-words by web-mech](https://github.com/web-mech/badwords)<br>
[jsVideoUrlParser by Zod-](https://github.com/Zod-/jsVideoUrlParser)<br>
[openGraphScraper by jshemas](https://github.com/jshemas/openGraphScraper)<br>
[metafetch by brahma-dev](https://github.com/brahma-dev/metafetch)<br>
[qrcode-svg by papnkukn](https://github.com/papnkukn/qrcode-svg)

[bad-words by web-mech](https://github.com/web-mech/badwords)

# LICENSE
* MIT
[jsVideoUrlParser by Zod-](https://github.com/Zod-/jsVideoUrlParser)

[openGraphScraper by jshemas](https://github.com/jshemas/openGraphScraper)

[metafetch by brahma-dev](https://github.com/brahma-dev/metafetch)

## LICENSE

* MIT

8 changes: 8 additions & 0 deletions src/router.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ module.exports = (app, dir) => {
const resMsgs = require('./responseMessages');
const conf = require('./config');


/**
* @description redirect to project repo
*/
app.get('/', (req, res) =>{
res.redirect('https://github.com/Matsukii/polarpod');
})

/**
* @description og tag getter api
*/
Expand Down

0 comments on commit f79b2cd

Please sign in to comment.