Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mmilk23/image_unmirrorer

Image Unmirrorer is an API that allows users to upload an image and receive a horizontally mirrored version in return. Developed with Elixir, this project can be easily run using Docker, making it simple and quick to set up.
https://github.com/mmilk23/image_unmirrorer

docker docker-compose elixir image-editing-api image-manipulation image-mirroring image-processing microservices openapi

Last synced: 21 days ago
JSON representation

Host: GitHub
URL: https://github.com/mmilk23/image_unmirrorer
Owner: mmilk23
License: mit
Created: 2024-11-23T23:20:25.000Z (3 months ago)
Default Branch: main
Last Pushed: 2025-01-02T17:13:49.000Z (about 1 month ago)
Last Synced: 2025-01-02T18:23:57.816Z (about 1 month ago)
Topics: docker, docker-compose, elixir, image-editing-api, image-manipulation, image-mirroring, image-processing, microservices, openapi
Language: Elixir
Homepage:
Size: 15.7 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Image Unmirrorer

[![Build Status](https://github.com/mmilk23/image_unmirrorer/actions/workflows/elixir.yml/badge.svg)](https://github.com/mmilk23/image_unmirrorer/actions)
[![codecov](https://codecov.io/gh/mmilk23/image_unmirrorer/branch/main/graph/badge.svg)](https://codecov.io/gh/mmilk23/image_unmirrorer)
[![Coverage Status](https://coveralls.io/repos/github/mmilk23/image_unmirrorer/badge.svg)](https://coveralls.io/github/mmilk23/image_unmirrorer)
![Dependabot](https://img.shields.io/badge/Dependabot-enabled-brightgreen)
[![Last Updated](https://img.shields.io/github/last-commit/mmilk23/image_unmirrorer.svg)](https://github.com/mmilk23/image_unmirrorer/commits/main)

The **Image Unmirrorer** is an API that allows users to upload an image and receive a horizontally mirrored version in return.
Developed in Elixir, this project can be easily run using Docker, making it simple and quick to set up.

## Features
- Mirrors uploaded images (supports JPEG and PNG formats).
- Easy integration via RESTful API.

## Live Demo 🌟

Explore the features of the application through the link below:

🔗 [Try the Live Demo](https://image-unmirrorer.gigalixirapp.com/testmirror.html)

### OpenAPI Specification
To access the API specification (OpenAPI), click the link below:

📜 [View OpenAPI Spec](https://image-unmirrorer.gigalixirapp.com/openapi.json)

## How to Run the Project

### Requirements
- Docker
- Elixir (if you wish to run it locally without Docker)

### Running with Docker
1. Clone the repository:
```sh
git clone https://github.com/mmilk23/image_unmirrorer.git
cd image_unmirrorer
```

2. Build and run the container:
```sh
docker build -t image_unmirrorer .
docker run -p 4000:4000 image_unmirrorer
```

3. Access the application in your browser:
```
http://localhost:4000
```

### Running Locally (Without Docker)
1. Clone the repository:
```sh
git clone https://github.com/mmilk23/image_unmirrorer.git
cd image_unmirrorer
```

2. Install dependencies:
```sh
mix deps.get
```

3. Compile the project:
```sh
mix clean
mix compile
```

4. Run the application:
```sh
mix run --no-halt
```

5. Access the application in your browser:
```
http://localhost:4000
```

## API Endpoints
- **POST /mirror**: Receives an image and returns its horizontally mirrored version.
- **GET /openapi.json**: Provides the OpenAPI specification for the API.

### Example Request
```sh
curl -X POST http://localhost:4000/mirror -H "Content-Type: image/jpeg" --data-binary @your_image.jpg -o image-mirror.jpg
```

## Testing
You can test the application by accessing the `testmirror.html` file in your browser:
```
http://localhost:4000/testmirror.html
```

Alternatively, you can use a CURL command:
```sh
curl -X POST -H "Content-Type: image/jpeg" --data-binary @your_image.jpg http://localhost:4000/mirror --output image-mirror.jpg
```

To run coverage tests:
```sh
mix test --cover
```

## Technologies Used
- Elixir
- Docker

## Contributing
Contributions are more than welcome!
Feel free to submit a pull request or open an issue to discuss improvements or report bugs.

## License
This project is licensed under the MIT License.

## Disclaimer
This project was developed as part of a system architecture playground and is not recommended for production environments without an in-depth review.

If you found this project helpful, please consider giving it a star ⭐️.

## Contact
For more information, visit the [GitHub repository](https://github.com/mmilk23/image_unmirrorer).