https://github.com/alexrogalskiy/wotd
🌐 Styled Word of the Day API
https://github.com/alexrogalskiy/wotd
typescript vercel-serverless-functions wotd
Last synced: 4 months ago
JSON representation
🌐 Styled Word of the Day API
- Host: GitHub
- URL: https://github.com/alexrogalskiy/wotd
- Owner: AlexRogalskiy
- License: gpl-3.0
- Created: 2021-02-22T13:32:07.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-23T05:42:30.000Z (6 months ago)
- Last Synced: 2024-11-24T18:57:08.016Z (6 months ago)
- Topics: typescript, vercel-serverless-functions, wotd
- Language: TypeScript
- Homepage: https://styled-wotd.vercel.app/
- Size: 1.98 MB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 340
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: .github/support.yml
Awesome Lists containing this project
README
# *Styled Word of the Day*
> Generate SVG [styled wotd](https://en.wiktionary.org/wiki/Wiktionary:Word_of_the_day)
[](https://deepsource.io/gh/AlexRogalskiy/wotd/?ref=repository-badge)
[](https://deepscan.io/dashboard#view=project\&tid=11946\&pid=16532\&bid=357958)
[](https://github.com/XAMPPRocky/tokei)
[](https://houndci.com)
[](https://zenodo.org/badge/latestdoi/341363749)
[](https://david-dm.org/AlexRogalskiy/wotd)
[](https://david-dm.org/AlexRogalskiy/wotd)
[](https://david-dm.org/AlexRogalskiy/wotd?type=dev)
[](https://raw.githubusercontent.com/alexrogalskiy/wotd/master/LICENSE?token=AH44ZFH7IF2KSEDK7LSIW3C7YOFYC)
[](https://img.shields.io/github/issues/alexrogalskiy/wotd)
[](https://img.shields.io/github/forks/alexrogalskiy/wotd)
[](https://img.shields.io/github/stars/alexrogalskiy/wotd)
[](https://codeclimate.com/github/AlexRogalskiy/wotd/maintainability)
[](https://lgtm.com/projects/g/AlexRogalskiy/wotd/alerts/)
[](https://lgtm.com/projects/g/AlexRogalskiy/wotd/context:javascript)
[](https://codebeat.co/projects/github-com-alexrogalskiy-wotd-master)
[](https://renovatebot.com/)
[](https://dependabot.com/)
[](https://newreleases.io/github/AlexRogalskiy/wotd)
[](https://hitsofcode.com/github/AlexRogalskiy/wotd/view)
[][tags]
[](https://codecov.io/gh/AlexRogalskiy/wotd)
[](https://github.com/AlexRogalskiy/wotd/actions/workflows/build.yml)
[](https://github.com/marketplace/actions/super-linter)
[](https://github.com/OrRosenblatt/validate-json-action)
[](https://bettercodehub.com/)
[](https://gitpod.io/#https://github.com/AlexRogalskiy/wotd)
[](https://github.com/AlexRogalskiy/wotd/discussions)
[](https://github.com/AlexRogalskiy/wotd/labels/question)
[](https://github.com/AlexRogalskiy/wotd/labels/bug)
## *Table of contents*
- [*Description*](#description)
- [*How to use*](#how-to-use)
- [*Example*](#example)
- [*Visitor stats*](#visitor-stats)
- [*Licensing*](#licensing)
- [*Authors*](#authors)
- [*Versioning*](#versioning)
- [*Contribution*](#contribution)
- [*Acknowledgement*](#acknowledgement)
- [*Forks*](#forks)
- [*Issues*](#issues)
- [*Team Tools*](#team-tools)
- [*OpenGraph Card*](#opengraph-card)
- [*Development Support*](#development-support)
## *Description*
***Styled Word of the Day*** is a serverless function that dynamically generates styled word images based on SVG (Scalable Vector Graphics).
For the tech stack, ***Styled Word of the Day*** using Typescript and serverless function from Vercel stack.
## *How to use*
It's simple, you can copy paste this markdown content, like this one:
```
```
There are several options you can use from the list:
| **Options** | **Description** | **Type** | **Example** | **Query Params** |
| ----------------------------- | ---------------------------------- | --------------------------------- | ------------------ | -------------------------- |
| **\[Theme]** | Theme of the image | String | default_repocard | `?theme=[value]` |
| **\[Layout]** | Layout of the image | String | default | `&layout=[value]` |
| **\[Animation]** | Animation of the image | String | grow_out_in | `&animation=[value]` |
| **\[Background Color]** | Background color of the image | Hex color code | ffffff | `&bgColor=[value]` |
| **\[Opacity Pattern]** | Opacity of the background pattern | Float number | 0 - 1 | `&opacity=[value]` |
| **\[Color Pattern]** | Color of the background pattern | Hex color code | 1abc9c | `&colorPattern=[value]` |
| **\[Primary Font Color]** | Primary font color of the text | Hex color code | 000000 | `&primaryColor=[value]` |
| **\[Secondary Font Color]** | Secondary font color of the text | Hex color code | 000000 | `&secondaryColor=[value]` |
| **\[Pattern]** | Background pattern | String constant | plus | `&pattern=[value]` |
| **\[Language]** | Word language | String constant | balinese | `&language=[value]` |
| **\[Width]** | Image width | String | 100% | `&width=[value]` |
| **\[Height]** | Image height | String | 100% | `&height=[value]` |
Here is a list of supported image themes:
| **Name** | **Value** |
| --------------------------------- | ----------------------------- |
| **Default** | default |
| **Default repocard** | default_repocard |
| **Dark** | dark |
| **Radical** | radical |
| **Merko** | merko |
| **Gruvbox** | gruvbox |
| **Tokyo night** | tokyonight |
| **One dark** | onedark |
| **Cobalt** | cobalt |
| **Synth wave** | synthwave |
| **High contrast** | highcontrast |
| **Dracula** | dracula |
| **Prussian** | prussian |
| **Monokai** | monokai |
| **Vue** | vue |
| **Vue dark** | vue_dark |
| **Shades of purple** | shades_of_purple |
| **Night owl** | nightowl |
| **Buefy** | buefy |
| **Blue green** | blue_green |
| **Algolia** | algolia |
| **Great Gatsby** | great_gatsby |
| **Darcula** | darcula |
| **Bear** | bear |
| **Solarized dark** | solarized_dark |
| **Solarized light** | solarized_light |
| **Chartreuse dark** | chartreuse_dark |
| **Nord** | nord |
| **Gotham** | gotham |
| **Material pale night** | material_palenight |
| **Gray white** | graywhite |
| **Vision friendly dark** | vision_friendly_dark |
| **Ayu mirage** | ayu_mirage |
| **Midnight purple** | midnight_purple |
| **Calm** | calm |
| **Flag India** | flag_india |
| **Omni** | omni |
| **React** | react |
| **Jolly** | jolly |
| **Maroongold** | maroongold |
| **Yeblu** | yeblu |
| **Blueberry** | blueberry |
| **State orange** | slateorange |
| **Kacho ga** | kacho_ga |
| **Arabesque** | arabesque |
List of supported image layouts:
| **Name** | **Value** |
| --------------------------------- | ----------------------------- |
| **Default** | default |
List of supported image animations:
| **Name** | **Value** |
| --------------------------------- | ----------------------------- |
| **Default** | default |
| **Grow-out-in** | grow_out_in |
List of supported languages:
| **Name** | **Value** |
| --------------------------------- | --------------------- |
| **Arabic** | arabic |
| **Balinese** | balinese |
| **Chinese (mandarin)** | mandarin_chinese |
| **Dari** | dari |
| **Dutch** | dutch |
| **English (portuguese)** | portuguese_english |
| **English (spanish)** | spanish_english |
| **Esperanto** | esperanto |
| **French** | french |
| **German** | german |
| **Hebrew** | hebrew |
| **Hindi** | hindi |
| **Indonesian** | indonesian |
| **Irish** | irish |
| **Italian** | italian |
| **Japanese** | japanese |
| **Korean** | korean |
| **Latin** | latin |
| **Norwegian** | norwegian |
| **Pashto** | pashto |
| **Polish** | polish |
| **Brazilian** | brazilian |
| **Russian** | russian |
| **Spanish** | spanish |
| **Swedish** | swedish |
| **Turkish** | turkish |
| **Urdu** | urdu |
Patterns provided by [Hero Pattern](https://github.com/lowmess/hero-patterns) package which is developed by [Lowmess](https://github.com/lowmess/):
| **Name** | **Value** |
| --------------------------------- | ----------------------------- |
| **Jigsaw** | jigsaw |
| **Overcast** | overcast |
| **Formal Invitation** | formalInvitation |
| **Topography** | topography |
| **Texture** | texture |
| **Jupiter** | jupiter |
| **Architect** | architect |
| **Cutout** | cutout |
| **Hideout** | hideout |
| **Graph Paper** | graphPaper |
| **Yyy** | yyy |
| **Squares** | squares |
| **Falling Triangles** | fallingTriangles |
| **Piano Man** | pianoMan |
| **Pie Factory** | pieFactory |
| **Dominos** | dominos |
| **Hexagons** | hexagons |
| **Charlie Brown** | charlieBrown |
| **Autumn** | autumn |
| **Temple** | temple |
| **Stamp Collection** | stampCollection |
| **Death Star** | deathStar |
| **Church on Sunday** | churchOnSunday |
| **I Like Food** | iLikeFood |
| **Overlapping Hexagons** | overlappingHexagons |
| **Four Point Stars** | fourPointStars |
| **Bamboo** | bamboo |
| **Bathroom Floor** | bathroomFloor |
| **CorkScrew** | corkScrew |
| **Happy Intersection** | happyIntersection |
| **Kiwi** | kiwi |
| **Lisbon** | lisbon |
| **Random Shapes** | randomShapes |
| **Steel Beams** | steelBeams |
| **Tiny Checkers** | tinyCheckers |
| **X Equals** | xEquals |
| **Anchors Away** | anchorsAway |
| **Bevel Circle** | bevelCircle |
| **Brick Wall** | brickWall |
| **Fancy Rectangles** | fancyRectangles |
| **Heavy Rain** | heavyRain |
| **Overlapping Circles** | overlappingCircles |
| **Plus** | plus |
| **Rounded Plus Connected** | roundedPlusConnected |
| **Volcano Lamp** | volcanoLamp |
| **Wiggle** | wiggle |
| **Bubbles** | bubbles |
| **Cage** | cage |
| **Connections** | connections |
| **Current** | current |
| **Diagonal Stripes** | diagonalStripes |
| **Flipped Diamonds** | flippedDiamonds |
| **Floating Cogs** | floatingCogs |
| **Glamorous** | glamorous |
| **Hounds tooth** | houndstooth |
| **Leaf** | leaf |
| **Lines In Motion** | linesInMotion |
| **Moroccan** | moroccan |
| **Morphing Diamonds** | morphingDiamonds |
| **Rails** | rails |
| **Rain** | rain |
| **Skulls** | skulls |
| **Squares In Squares** | squaresInSquares |
| **Stripes** | stripes |
| **Tic Tac Toe** | ticTacToe |
| **ZigZag** | zigZag |
| **Aztec** | aztec |
| **BankNote** | bankNote |
| **Boxes** | boxes |
| **Circles And Squares** | circlesAndSquares |
| **CircuitBoard** | circuitBoard |
| **Curtain** | curtain |
| **Diagonal Lines** | diagonalLines |
| **Endless Clouds** | endlessClouds |
| **Eyes** | eyes |
| **Floor Tile** | floorTile |
| **Groovy** | groovy |
| **Intersecting Circles** | intersectingCircles |
| **Melt** | melt |
| **Overlapping Diamonds** | overlappingDiamonds |
| **Parkay Floor** | parkayFloor |
| **Pixel Dots** | pixelDots |
| **Polka Dots** | polkaDots |
| **Signal** | signal |
| **Slanted** Stars | slantedStars |
| **Wallpaper** | wallpaper |
## *Example*
This is example of using ***Styled Word of the Day***:
```
```
Result:
## *Visitor stats*
[](https://hits.seeyoufarm.com)
## *Licensing*
***Styled Word of the Day*** is distributed under LGPL version 3 or later, \[[License](https://github.com/AlexRogalskiy/wotd/blob/master/LICENSE)].
LGPLv3 is additional permissions on top of GPLv3.
## *Authors*
***Styled Word of the Day*** is maintained by the following GitHub team-members:
- [](https://github.com/AlexRogalskiy)
with community support please contact with us if you have some question or proposition.
## *Kubernetes*
Running k8s cluster with tilt command by acquiring k8s deployment configuration:
```shell
tilt up
```
Shutting down k8s cluster with provisioned resources removal:
```shell
tilt down --delete-namespaces
```
## *Versioning*
The project uses [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository][tags].
## *Contribution*
[](https://badges.pufler.dev)
Please read
[CONTRIBUTING.md](https://github.com/AlexRogalskiy/wotd/blob/master/.github/CONTRIBUTING.md)
for details on our code of conduct, and the process for submitting pull requests to us ([emoji key](https://allcontributors.org/docs/en/emoji-key)).
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome!
[](http://makeapullrequest.com)
See also the list of [contributors][contributors] who participated in this project.
## *Acknowledgement*
[][stars]
[][stars_chart]
## *Forks*
[][forkers]
## *Issues*
[](https://issuehunt.io/r/AlexRogalskiy/wotd)
## *Team Tools*
[](https://www.jetbrains.com/)
***Styled wotd*** Team would like inform that JetBrains is helping by provided IDE to develop the application. Thanks to its support program for an Open Source projects!
[](https://gitpod.io/#https://github.com/AlexRogalskiy/wotd)
***Styled wotd*** has experimental support for Gitpod, a pre-configured development environment that runs in your browser. To use Gitpod, click the button below and sign in with GitHub. Gitpod also offers a browser add-on, though it is not required.
[](https://lunrjs.com/guides/getting_started.html)
***Styled wotd*** project is using Lunr search tool to index and query text data by keywords.
## *OpenGraph Card*
## *Development Support*
Like ***Styled Word of the Day*** ? Consider buying me a coffee :)
[](https://www.patreon.com/alexrogalskiy)
[](https://www.buymeacoffee.com/AlexRogalskiy)
[](https://ko-fi.com/alexrogalskiy)
***
[](https://www.typescriptlang.org/)
[](https://vercel.com/)
[](https://forthebadge.com/)
[repo]: https://github.com/AlexRogalskiy/wotd
[tags]: https://github.com/AlexRogalskiy/wotd/tags
[issues]: https://github.com/AlexRogalskiy/wotd/issues
[pulls]: https://github.com/AlexRogalskiy/wotd/pulls
[wiki]: https://github.com/AlexRogalskiy/wotd/wiki
[stars]: https://github.com/AlexRogalskiy/wotd/stargazers
[stars_chart]: https://starchart.cc/AlexRogalskiy/wotd
[forkers]: https://github.com/AlexRogalskiy/wotd/network/members
[contributors]: https://github.com/AlexRogalskiy/wotd/graphs/contributors