https://github.com/crizmo/jng
Converts .jpg urls to .png urls and vice versa.
https://github.com/crizmo/jng
convert jpg png url
Last synced: 10 months ago
JSON representation
Converts .jpg urls to .png urls and vice versa.
- Host: GitHub
- URL: https://github.com/crizmo/jng
- Owner: crizmo
- License: mit
- Created: 2023-07-05T17:19:39.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-07T09:12:30.000Z (almost 3 years ago)
- Last Synced: 2025-08-09T08:57:47.401Z (10 months ago)
- Topics: convert, jpg, png, url
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/jng
- Size: 17.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: License
Awesome Lists containing this project
README
JNG
Convert .jpg urls to .png urls and vice versa
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
## 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.
## 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
7. Install the required packages - `cloudinary, dotenv, fs`
8. Install jng using npm
```sh
npm install jng
```
9. Require the package in your main file
```JS
const jng = require('jng');
```
## Functions
```javascript
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 -
```json
[
"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
## Usage
```javascript
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);
});
```
## For more information on how to use it visit
- [Github](https://github.com/crizmo/JNG)
- [Example](https://github.com/crizmo/JNG/tree/main/tests)
## 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/JNG/issues) for a full list of proposed features (and known issues).
## 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
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
Package Made by: `kurizu.taz` on discord
Github - [https://github.com/crizmo/JNG](https://github.com/crizmo/JNG)