Skip to content

AlperRehaYAZGAN/temp-file-transfer-app

Repository files navigation

Contributors Issues MIT License

Temp File Transfer Web Application


Simple temporary file upload and transfer web application coding with Go language.
Explore the Golang »

Live Demo at https://tempft.herokuapp.com

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. TODO
  6. Contributing
  7. License
  8. Contact
  9. Acknowledgements

About The Project

This project aiming to create a simple temporary file trasnfer app for general purposes. With this app you could upload file to service then retrieve from unique key for specific (1 minute) time validity. Demo app is listening on (https://alya-temp-file.herokuapp.com) .

Built With

Getting Started

Prerequisites

  • Golang
    Install latest Golang  
    https://go.dev 
    
  • Docker
    Install docker on your OS  
    https://docs.docker.com/get-docker/  
  • Heroku
    Quick look website  
    https://www.heroku.com 
    

Installation

  1. Clone the repo:
    git clone https://github.com/AlperRehaYAZGAN/temp-file-transfer-app.git  
    cd temp-file-transfer-app
  2. Run app directly:
    go build -o ./bin/myexeapp
    ./bin/myexeapp
  3. Build docker image:
    docker build -t alperreha/alya-temp-file:1.0.0
  4. Run Docker container:
    docker run --name alya-temp-file -p 9090:9090 -d alperreha/alya-temp-file:1.0.0

Usage

This simple app has a two endpoint to handle whole process. If we assert server is listening on 9090 port, example requests are:

  • GET / : HTML Home Page for upload file
  • GET /f/:file-key : Returns file info page by file-uploaded-temp-key
  • GET /api/:key/:filename : api get file by key
  • POST /api/:filename : Form Data myfile for uploading file and returns file key to access

Roadmap

See the open issues for a list of proposed features (and known issues).

TODO

  • JWT encode,decode and verify
  • [-] Custom TCP Transport for microservices
  • [-]

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  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 for more information.

Contact

Alper Reha YAZGAN - @alperreha - alper@yazgan.xyz

Project Link: https://github.com/AlperRehaYAZGAN/temp-file-transfer-app

About

A simple Temp File Transfer Go Application. (https://tempft.herokuapp.com)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published