faker-file-ui

ReactJS/MaterialUI based UI frontend for faker-file-api REST API.

Prerequisites

• Running faker-file-api REST API service.
• NodeJS

Installation

npm install

Running

npm start

How it is supposed to work?

The wizard

Three column design:

| File type             | Options               | Result                |
| --------------------- | --------------------- | --------------------- |
|  - bin                | basename ____________ | -> Download           |
|  - csv                | prefix ______________ |                       |
|  -> docx              | max_nb_chars ________ |                       |
|  - eml                | wrap_chars_after ____ |                       |
|  - epub               | content _____________ |                       |
|  - epub               |                       |                       |
|  - generic            |                       |                       |
|  - ico                | -> Generate           |                       |
|  - jpeg               |                       |                       |
|  - mp3                |                       |                       |
|  - odp                |                       |                       |
|  - ods                |                       |                       |
|  - odt                |                       |                       |
|  - pdf                |                       |                       |
|  - png                |                       |                       |
|  - pptx               |                       |                       |
|  - rtf                |                       |                       |
|  - svg                |                       |                       |
|  - tar                |                       |                       |
|  - txt                |                       |                       |
|  - xlsx               |                       |                       |
|  - xml                |                       |                       |
|  - zip                |                       |                       |

Step 1: Choose File type

• File type

Step 2: Fine tune the Options (specific for each File type)

• All options of faker-file are be supported, except for a very specific ones, such as storage.

Step 3: Generate file

• Clicking on Generate button, should generate the file and render Download link in the Result column.

Supported file types

• BIN
• CSV
• DOCX
• EML
• EPUB
• ICO
• JPEG
• MP3
• ODS
• ODT
• ODP
• PDF
• PNG
• RTF
• PPTX
• SVG
• TAR
• TXT
• XLSX
• XML
• ZIP

Writing documentation

Keep the following hierarchy.

=====
title
=====

header
======

sub-header
----------

sub-sub-header
~~~~~~~~~~~~~~

sub-sub-sub-header
^^^^^^^^^^^^^^^^^^

sub-sub-sub-sub-header
++++++++++++++++++++++

sub-sub-sub-sub-sub-header
**************************

Testing

Run tests against running instance

Run all tests:

npx cypress open

Run all tests in headless mode:

npx cypress run --headless

Run tests instance and tests

Run all tests:

npm run cy:test

Run all tests in headless mode:

npm run cy:test-headless

License

MIT

Support

For security issues contact me at the e-mail given in the Author section.

For overall issues, go to GitHub.

Author

Artur Barseghyan <artur.barseghyan@gmail.com>