README.md

UPIXEL-FILESERVER

Table of Contents

• Overview
• Project Structure
• Getting Started
  • Prerequisites
  • Installation
  • Configuration
  • Usage

Overview

❯ Microservice for manage images and other files for uPixel store.

Project Structure

└── upixel-fileserver/
    ├── .github
    │   └── workflows
    ├── LICENSE
    ├── misc
    │   └── upixel_fileserver_postman.json
    ├── package-lock.json
    ├── package.json
    └── src
        ├── config
        ├── controllers
        ├── error-handler.js
        ├── middlewares
        ├── server.js
        └── services

Routes

Route	Method	Details
Index	GET	Show API information
List	GET	List all files
Upload	POST	Upload any file to temp directory
Confirm	POST	Move staged file from temp directory to corresponding folder
Cancel	DELETE	Delete staged file at temp directory
Delete	DELETE	Delete file regardless of the location

Getting Started

Prerequisites

Before getting started with upixel-fileserver, ensure your runtime environment meets the following requirements:

• Version Control System: Git
• Javascript Runtime: NodeJS
• Package Manager: Npm (Installed with NodeJS)

Installation

1. Clone the upixel-fileserver repository:

❯ git clone https://github.com/Artursrossi/upixel-fileserver

2. Navigate to the project directory:

❯ cd upixel-fileserver

3. Install the project dependencies: Using npm  

❯ npm install

Configuration

Set the environment variables by creating a .env file using .env.example

Usage

Run upixel-fileserver using the following command: Using npm  

❯ npm start