JNG

Convert .jpg urls to .png urls and vice versa
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Functions
   • Usage
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

Converts .jpg urls to .png urls and vice versa.

• How it works
  Images are sent to a cloudinary server and then converted to .png or .jpg.
  The package willthen return the changed url.
  

(back to top)

Getting Started

1. Make a account on cloudinary - https://cloudinary.com/users/register/free
2. Copy the cloud name, api key and api secret from the cloudinary console - https://cloudinary.com/console
3. Paste the cloud name, api key and api secret in the .env file named CLOUD_NAME, API_KEY and API_SECRET
4. Check env_example file for more info - env_example
5. Install the required packages - cloudinary, dotenv, fs
6. Install jng using npm
   

   npm install jng

7. Require the package in your main file
   

   const jng = require('jng');

(back to top)

Functions

jng.init({
    cloud_name: process.env.CLOUD_NAME,
    api_key: process.env.API_KEY,
    api_secret: process.env.API_SECRET
});

// Init function is used to setup the cloudinary server

jng.upload('tests/test.json', 'kurizu', 'png', 'anime').then(url => {
    console.log(url);
});

Note

1. Here tests/test.json - is the path to the image you want to send and it looks like this -

[ 
  "https://kurizuanime_1.jpg", 
  "https://kurizuanime_2.jpg" 
]

2. kurizu - is the name that i want to add to the url
3. png - is the format that i want to convert the image to
4. anime - is the tag that i want to add to the image

// Upload function uploads the image to the channel and then fetches its url Check env_example file for more info - env_example

(back to top)

Usage

const jng = require('jng');
require('dotenv').config()

jng.init({
    cloud_name: process.env.CLOUD_NAME,
    api_key: process.env.API_KEY,
    api_secret: process.env.API_SECRET
});

jng.upload('tests/test.json', 'kurizu', 'png', 'anime').then(url => {
    console.log(url);
});

(back to top)

For more information on how to use it visit

• Github
• Example

(back to top)

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 for a full list of proposed features (and known issues).

(back to top)

Contributions

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Package Made by: kurizu.taz on discord
Github - https://github.com/crizmo/JNG