https://github.com/mohitkyadav/cool-name-api
https://github.com/mohitkyadav/cool-name-api
cool-name css glitch js
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mohitkyadav/cool-name-api
- Owner: mohitkyadav
- License: mit
- Created: 2018-07-15T13:11:12.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-20T12:20:44.000Z (almost 7 years ago)
- Last Synced: 2025-04-12T00:43:20.737Z (8 months ago)
- Topics: cool-name, css, glitch, js
- Language: CSS
- Homepage: https://cool-name-api.glitch.me/
- Size: 306 KB
- Stars: 16
- Watchers: 2
- Forks: 15
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# cool-name-api
[](https://travis-ci.org/mohitkyadav/cool-name-api)
This is a website and node.js project to transform text into a cool representation of that text.
For example `wolverine` becomes:
* `ⓦ0lv3r1nⓔ`
* `wo|ver!ne`
* `🅆🄾🄻🅅🄴🅁🄸🄽🄴`
* `ⓦⓞⓛⓥⓔⓡⓘⓝⓔ`
* `w01v3r1n3`
* `🔱⚽👢✅🎗🌱🎐🎵🎗`
* `w͓̽o͓̽l͓̽v͓̽e͓̽r͓̽i͓̽n͓̽e͓̽`
* (backwards) `wolverine`
## Demo
To see the API in action, you can visit the website at https://cool-name-api.glitch.me/
## Usage
### coolify
* request URL: https://cool-name-api.glitch.me/coolify
* query params (required): `name`
* example with 'wolverine': https://cool-name-api.glitch.me/coolify?name=wolverine
```
$ curl -X GET 'https://cool-name-api.glitch.me/coolify?name=wolverine'
```
### uncoolify
* request URL: https://cool-name-api.glitch.me/uncoolify
* query params (required): `name`
* example with '🌛🌱⛎〽️🅿️🎏': https://cool-name-api.glitch.me/uncoolify?name=%F0%9F%8C%9B%F0%9F%8C%B1%E2%9B%8E%E3%80%BD%EF%B8%8F%F0%9F%85%BF%EF%B8%8F%F0%9F%8E%8F
```
$ curl -X GET 'http://localhost:3000/uncoolify?name=%F0%9F%8C%9B%F0%9F%8C%B1%E2%9B%8E%E3%80%BD%EF%B8%8F%F0%9F%85%BF%EF%B8%8F%F0%9F%8E%8F'
```
## Build Setup
* **Step 1:** Fork the cool-name-api repository and clone it to your machine
* **Step 2:** Cd into the cloned folder
* **Step 3:** Install all the dependencies with:```$ npm install```
* **Step 4:** Run on http://localhost:3000 with:```$ npm start```
## Contribute
Found a bug, please [create an issue](https://github.com/mohitkyadav/cool-name-api/issues/new)
## License
[](LICENSE)
## Live Website Hosting
The live website is hosted on [Glitch](https://glitch.com/about).
You can [remix it there](https://glitch.com/edit/#!/cool-name-api).