SimpleDataTransfer

SimpleDataTransfer is a web application with which you can easily send files and text with a QR code or pin. I started this project for fun to get some experience with nestJS. If you have suggestions for improvements of the code or ideas for new features just open an issue.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• License
• Contact

About The Project

SimpleDataTransfer is a web application with which you can easily send files and text with a QR code or pin. I started this project for fun to get some experience with nestJS. If you have suggestions for improvements of the code or ideas for new features just open an issue.

A list of commonly used resources that I find helpful are listed in the acknowledgements.

Built With

• Angular
• Angular Material Design
• NestJs

Getting Started

Prerequisites

• Node.js - Install Node.js

• Docker - Install Docker

Installation

The easiest way to use SimpleDataTransfer is to use Docker and Docker Compose:

1. Download the docker-compose template:

   curl https://raw.githubusercontent.com/NGroens/SimpleDataTransfer/master/sdt-database/docker-compose-example.yml --output docker-compose.yml

2. Replace your domain name in the docker-compose.yml and follow the instructions at the end of each line.
3. Start all containers with the following command:

   docker-compose up -d

Installation for development purposes

1. Clone the repo

   git clone https://github.com/NGroens/SimpleDataTransfer.git

2. Start docker development environment

   cd sdt-database
   docker-compose -f docker-compose-dev.yml up -d

   or on Windows

   cd sdt-database
   start-dev.bat

3. Navigate to backend server, install npm dependencies and start the server

   cd ../sdf-server
   npm i
   npm run start:dev

4. Navigate to frontend, install npm dependencies and start the application

    cd ../sdf-frontend
    npm i
    npm start    

Usage

Screenshots

Choose if you want to send or receive data

Data receive page

Show highlighted text

Select if you want to scan a qr code or enter a pin

Scan qr code

Enter pin

Send a file or text

Muli language system

Light and dark mode

Roadmap

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

License

Distributed under the Apache-2.0 License. See LICENSE for more information.

Contact

NGroens - sdf@mycoding.systems

Project Link: https://github.com/NGroens/SimpleDataTransfer