Carbonyl

Fast and seamless URL minifier API

Table of Contents

• Description
• Getting Started
• Prerequisites
• Installation
• Usage
• Support
• License

Description

Getting Started

To host the application on your servers, fork the project, afterwards, clone it to your machine and install the dependencies

git clone https://github.com/<your-github-username>/otter
cd otter
npm install

Prerequisites

The following are required to run the project locally

• Node.js - Cross platform JavaScript run time environment
• npm - JavaScript package manager
• MongoDB - NoSQL database

Integration

Get started with cURl

curl  -X POST \
 'https://carbonyl.conrender.com/api/v2/minify' \
 --header 'Accept: */*' \
 --header 'Content-Type: application/json' \
 --data-raw '{
 "url":"<url-goes-here>"
}'

Language Integration

see the documentation for the following language integration

• Bash
• C
• C#
• Clojure
• Go
• JavaScript
• Kotlin
• Node.js
• PHP
• Python
• Ruby

Support

License

This project is proprietary software owned by Adeoye Adefemi and distributed inder the MIT License