https://github.com/thelicato/asciified

A simple ASCII Art API with a good-looking Web App.
https://github.com/thelicato/asciified

api art ascii ascii-art koa react

Last synced: 15 days ago
JSON representation

A simple ASCII Art API with a good-looking Web App.

• Host: GitHub
• URL: https://github.com/thelicato/asciified
• Owner: thelicato
• License: gpl-3.0
• Created: 2022-01-16T16:15:03.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-29T09:04:38.000Z (10 months ago)
• Last Synced: 2024-08-02T13:35:18.339Z (3 months ago)
• Topics: api, art, ascii, ascii-art, koa, react
• Language: TypeScript
• Homepage: https://asciified.thelicato.io
• Size: 1.07 MB
• Stars: 16
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
```

                             ███   ███     ██████   ███               █████

                            ░░░   ░░░     ███░░███ ░░░               ░░███

  ██████    █████   ██████  ████  ████   ░███ ░░░  ████   ██████   ███████

 ░░░░░███  ███░░   ███░░███░░███ ░░███  ███████   ░░███  ███░░███ ███░░███

  ███████ ░░█████ ░███ ░░░  ░███  ░███ ░░░███░     ░███ ░███████ ░███ ░███

 ███░░███  ░░░░███░███  ███ ░███  ░███   ░███      ░███ ░███░░░  ░███ ░███

░░████████ ██████ ░░██████  █████ █████  █████     █████░░██████ ░░████████

 ░░░░░░░░ ░░░░░░   ░░░░░░  ░░░░░ ░░░░░  ░░░░░     ░░░░░  ░░░░░░   ░░░░░░░░

```

# asciified

A simple ASCII Art API with a good-looking Web App.

[![made-with-javascript](https://img.shields.io/badge/Made%20with-JavaScript-1f425f.svg)](https://www.javascript.com)

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/cybersecsi/RAUDI/blob/main/LICENSE)

## Web App

The web app is created using:

- [Next.js](https://nextjs.org/)

- [Tailwind CSS](https://tailwindcss.com)

And using the following packages:

- [figlet](https://www.npmjs.com/package/figlet)

- [dom-to-image](https://www.npmjs.com/package/dom-to-image)

- [react-icons](https://www.npmjs.com/package/react-icons)

- [use-clipboard-copy](https://www.npmjs.com/package/use-clipboard-copy)



  



In the webapp the user can type something and see the **asciified** version in **every font**. The user can also easily copy the text and, if the text is too long, it gets converted into an image using _dom-to-image_. Anyway it is still copyable.

## REST API

### [GET] /api/v2/ascii

#### Parameters

- **text**: the text to asciifiy

- **font** (optional): the font

#### Returns

The asciified text.

### [GET] /api/v2/fonts

#### Parameters

None

#### Returns

The list of _available fonts_

## License

**asciified** is an open-source and free software released under the [GNU GPL v3](https://github.com/thelicato/asciified/blob/main/LICENSE).