https://github.com/jfoyarzo/node-jimp
A Node.js app for processing images and converting them to grayscale. The backend is built with Node.js and uses the http and fs modules. Also uses the jimp package to process the image and yargs to create a command that includes a key for executing the server.
https://github.com/jfoyarzo/node-jimp
bootstrap http-server javascript jimp nodejs yargs
Last synced: about 2 months ago
JSON representation
A Node.js app for processing images and converting them to grayscale. The backend is built with Node.js and uses the http and fs modules. Also uses the jimp package to process the image and yargs to create a command that includes a key for executing the server.
- Host: GitHub
- URL: https://github.com/jfoyarzo/node-jimp
- Owner: jfoyarzo
- License: mit
- Created: 2023-04-09T02:45:05.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-09T04:25:31.000Z (about 3 years ago)
- Last Synced: 2025-04-24T06:29:22.791Z (about 1 year ago)
- Topics: bootstrap, http-server, javascript, jimp, nodejs, yargs
- Language: JavaScript
- Homepage: https://node-jimp.onrender.com
- Size: 18.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 Black and White Server ](#-black-and-white-server-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors ](#-authors-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [📝 License ](#-license-)
**Black and White Server** is a Node.js app for processing images and converting them to grayscale. The backend is built with Node.js and uses the `http` and `fs` modules. Also uses the `jimp` package to process the image and `yargs` to create a command that includes a key for executing the server.
Client/Server
- **Convert to grayscale** any image you want, as long as you have the URL.
- **Jimp** package is used for image processing.
- **Yargs** command is used to pass the correct key to the server so it can run.
- [Live Demo Link](https://node-jimp.onrender.com/)
To get a local copy up and running, follow these steps.
### Prerequisites
To run this project you need:
- Node.js
### Setup
Clone this repository to your desired folder:
```
git clone git@github.com:jfoyarzo/node-jimp.git
```
### Install
Install this project with:
```
npm install
```
### Usage
To run the project, execute the following command:
```
node index.js server --key yourSecretKey
```
You must also provide the key in a `.env` file as illustrated in the `.env.example` file.
This will start the server in the port provided using an environment variable or 3000 if no environment variable was configured.
👤 **Felipe Oyarzo**
- GitHub: [@jfoyarzo](https://github.com/jfoyarzo)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/jorge-felipe-oyarzo-contreras/)
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/jfoyarzo/node-jimp/issues).
If you like this project, please give it a star ⭐
This project is [MIT](./LICENSE) licensed.