Skip to content

Commit

Permalink
docs(readme): add instructions and images to describe how to use morp…
Browse files Browse the repository at this point in the history
…hos (#27)
  • Loading branch information
danvergara authored Jan 9, 2024
1 parent 732008f commit d9ef1b8
Show file tree
Hide file tree
Showing 8 changed files with 30 additions and 20 deletions.
50 changes: 30 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,45 +8,55 @@ __Self-Hosted file converter server.__
## Table of contents

- [Overview](#overview)
- [Dependencies](#Dependencies)
- [Installation](#Installation)
- [Docker](#Docker)
- [Features](#features)
- [License](#license)

## Overview

Today we are forced to rely on third party services to convert files to other formats. This is a serious threat to our privacy, if we use such services to convert files with highly sensitive personal data. It can be used against us, sooner or later.
Morphos server aims to solve the problem mentioned above, by providing a self-hosted server to convert files privately. The project provides an user-friendly web UI.

## Dependencies

* [Go 1.21](https://go.dev/doc/devel/release#go1.21.0)
* [air for local development](https://github.com/cosmtrek/air)
* [Docker](https://docs.docker.com/engine/install/)
* [Make](https://www.gnu.org/software/make/)
For now, Morphos only supports images. Documents will be added soon.

## Installation

The project is written in Go 1.21.


1. You can run the project on bare metal (this uses air for live-reloading):
### Docker

```
$ make run
```

2. On a container (make sure docker is installed)

```
$ make docker-build
$ make docker-run
docker run --rm -p 8080:8080 -v /tmp:/tmp ghcr.io/danvergara/morphos-server:latest
```

## Features

- Serves a nice web UI
- Simple installation (distributed as a Docker image)

## Usage

Run the server as mentioned above and open up your favorite browser. You'll see something like this:

<img src="screenshots/morphos.png"/>

Hit the file input section on the form to upload an image.

<img src="screenshots/upload_file_morphos.png"/>

You'll see the filed uploaded in the form.

<img src="screenshots/file_uploaded_morphos.png"/>

Then, you can select from a variety of other formats you can convert the current image to.

<img src="screenshots/select_options_morphos.png"/>

After hitting `Upload` button you will see a view like the one below, asking you to download the converted file.

<img src="screenshots/file_converted_morphos.png"/>

A modal will pop up with a preview of the converted image.

<img src="screenshots/modal_morphos.png"/>

## License
The MIT License (MIT). See [LICENSE](LICENSE) file for more details.
Binary file added screenshots/download_file_morphos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/file_converted_morphos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/file_uploaded_morphos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/modal_morphos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/morphos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/select_options_morphos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/upload_file_morphos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d9ef1b8

Please sign in to comment.