image2url

<a name="readme-top"></a> <div align="center"> <a href="https://github.com/crizmo/image2url"> <img src="https://cdn.discordapp.com/attachments/910210865683386408/1058270655625314344/Untitled_design.png" alt="Logo" width="80" height="80"> </a> <h3 align="center">Image2Url</h3> <a href="https://www.npmjs.com/package/image2url"><img src="https://img.shields.io/npm/v/image2url.svg?maxAge=3600&style=for-the-badge" alt="NPM version" /></a> <a href="https://www.npmjs.com/package/image2url"><img src="https://img.shields.io/npm/dt/image2url?style=for-the-badge" /></a> <a href="https://www.npmjs.com/package/image2url"><img src="https://img.shields.io/npm/l/image2url?style=for-the-badge" /></a> Convert images to urls <a href="https://github.com/crizmo/image2url">Explore the docs »</a> <a href="https://github.com/crizmo/image2url">View Demo</a> · <a href="https://github.com/crizmo/image2url/issues">Report Bug</a> · <a href="https://github.com/crizmo/image2url/issues">Request Feature</a> </div>  <details> <summary>Table of Contents</summary> <ol> <li> <a href="#about-the-project">About The Project</a> </li> <li> <a href="#getting-started">Getting Started</a> <ul> <li><a href="#functions">Functions</a></li> <li><a href="#usage">Usage</a></li> </ul> </li> <li><a href="#roadmap">Roadmap</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> <li><a href="#contact">Contact</a></li> </ol> </details>  ## About The Project Convert images to urls using discord bot / imgbb api - How it works For discord: Images are sent to a discord channel that you specify. The bot will then get the proxy url of the image and then return it to you. For imgbb: Images are sent to imgbb database and then the url is returned to you. (<a href="#readme-top">back to top</a>) ## Getting Started **For Discord** 1. Make a discord bot in discord developer portal 2. Copy the token and paste it in the .env file named `DISCORD_TOKEN` 3. Invite the bot to your server 4. Get the channel id of the channel where you want to send the images 5. Paste the channel id in the .env file named `DISCORD_CHANNEL` 6. Check env_example file for more info - <a href="/tests/.env_example">env_example</a> 7. Install the required packages - `discord.js, dotenv, fs` 8. Install image2url using npm ```sh npm install image2url ``` 9. Require the package in your main file ```JS const image2url = require('image2url'); ``` (<a href="#readme-top">back to top</a>) **For Imgbb** 1. Make an account on imgbb 2. Get the api key from the dashboard 3. Paste the api key in the .env file named `IMG_BB_KEY` 4. Install the required packages - `axios, dotenv, fs, form-data` ## Functions ```javascript // Discord upload image2url.init({ token: process.env.DISCORD_TOKEN, channel: process.env.DISCORD_CHANNEL }); image2url.upload('tests/kurizu.jpg', 'kurizu pfp').then(url => { console.log(url); }); // Imgbb upload const imagePath = 'tests/kurizu.jpg'; image2url.imgbb_upload(imagePath, process.env.IMG_BB_KEY) .then((url) => { console.log('Image uploaded successfully. URL:', url); }) .catch((error) => { console.error('Image upload failed with error:', error); }); ``` Check env_example file for more info - <a href="/tests/.env_example">env_example</a> (<a href="#readme-top">back to top</a>) ## Usage ```javascript const image2url = require('image2url'); require('dotenv').config() // Discord upload image2url.init({ token: process.env.DISCORD_TOKEN, channel: process.env.DISCORD_CHANNEL }); image2url.upload('tests/kurizu.jpg', 'kurizu pfp').then(url => { console.log(url); }); // Imgbb upload const imagePath = 'tests/kurizu.jpg'; image2url.imgbb_upload(imagePath, process.env.IMG_BB_KEY) .then((url) => { console.log('Image uploaded successfully. URL:', url); }) .catch((error) => { console.error('Image upload failed with error:', error); }); ``` Note: 1. tests/kurizu.jpg is the path to the image you want to send. 2. kurizu pfp is the name of the image. 3. The url will have the name that you specified. which in this case is kurizu pfp. (<a href="#readme-top">back to top</a>) ## For more information on how to use it visit - [Github](https://github.com/crizmo/image2url) - [Example](https://github.com/crizmo/image2url/tree/main/tests) (<a href="#readme-top">back to top</a>) ## Roadmap - [ ] Add Changelog - [ ] Add Tests - [ ] Add Additional Templates w/ Examples - [ ] Add Support for more image formats - [ ] Documentation - [ ] Website - [ ] Examples - [ ] Wiki - [ ] Add Support for more platforms See the [open issues](https://github.com/crizmo/image2url/issues) for a full list of proposed features (and known issues). (<a href="#readme-top">back to top</a>) ## Contributing Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again! 1. Fork the Project 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) 4. Push to the Branch (`git push origin feature/AmazingFeature`) 5. Open a Pull Request (<a href="#readme-top">back to top</a>)  ## License Distributed under the MIT License. See `LICENSE.txt` for more information. (<a href="#readme-top">back to top</a>) ## Contact Package Made by: `kurizu.taz` on discord Github - [https://github.com/crizmo/image2url](https://github.com/crizmo/image2url)