Skip to content

Latest commit

 

History

History
177 lines (120 loc) · 4.17 KB

README.md

File metadata and controls

177 lines (120 loc) · 4.17 KB
Raw

Website GitHub repo size GitHub contributions welcome

🌈 xColors API

A free API for generate & convert colors.

👓 Overview

xColors is a completely free service that provides the ability to get random colors and convert them into various color models (HEX, RGB and HSL are supported). All data comes in a convenient JSON format, so you can immediately use them for styling in CSS without additional validation.

📄 API Documentation

🎲 Get random color

Get a JSON object that contains a random color in three HEX, RGB and HSL color models at once.

https://x-colors.yurace.pro/api/random
{
    hex: "#CCFB7B",
    rgb: "rgb(204, 251, 123)",
    hsl: "hsl(82, 51%, 98%)"
}

🎨 Get random color with a given hue

You can get random shades of the color you need. For example, using reserved names such as:
[ red, pink, puprle, navy, blue, aqua, green, lime, yellow, orange ] 

https://x-colors.yurace.pro/api/random/blue

Instead of reserved words, you can use any number from the range [0, 359] - which corresponds to the HUE scale.

https://x-colors.yurace.pro/api/random/228

🔧 Parameters

The number parameter allows you to get an array containing the desired number of random colors.

?number=3

The type parameter allows you to get either only a dark or light shade of color. This allows you to know in advance what font color to use against the background of the resulting color. Usually, the font color is white on dark colors, and black on light colors.

It works if you have specified the {hue}/{color} you need or use all - for an any color.

/random/{hue/color/all}?type=dark
/random/{hue/color/all}?type=light

🔄 Converting сolors

You can freely convert colors between three color models. To do this, use the desired endpoint and use the value parameter to specify the color value of the color model, depending on the selected endpoint.

Convert HEX to RGB

https://x-colors.yurace.pro/api/hex2rgb?value=FFFFFF

Convert HEX to HSL

https://x-colors.yurace.pro/api/hex2hsl?value=FFFFFF

Convert RGB to HEX

https://x-colors.yurace.pro/api/rgb2hex?value=120-200-30

Convert RGB to HSL

https://x-colors.yurace.pro/api/rgb2hsl?value=120-200-30

Convert HSL to HEX

https://x-colors.yurace.pro/api/hsl2hex?value=300-90-50

Convert HSL to RGB

https://x-colors.yurace.pro/api/hsl2rgb?value=300-90-50

🎯 Examples

https://x-colors.yurace.pro/api/random?number=10
https://x-colors.yurace.pro/api/random/green?number=10&type=light
https://x-colors.yurace.pro/api/random/123?type=dark&number=2
https://x-colors.yurace.pro/api/hsl2hex/?value=hsl(200,20,10)
https://x-colors.yurace.pro/api/hex2rgb/?value=e2A4bF

⚡ Available Scripts

In the project directory, you can:

  • Run the server with Nodemon for development
npm run dev

The page will reload if you make edits.
You will also see any lint errors in the console.
Open http://localhost:5000 to view it in the browser.

  • Launch tests
npm run test
  • Create a production build
npm run build
  • Runs the server of production build
npm start

Open http://localhost:5000 to view it in the browser.

🐳 Docker startup

  1. Build docker image from Dockerfile:
docker build . -t xcolors
  1. Create docker container from new image:
docker run -p 5000:5000 -d --name xcolors-server xcolors