Skip to content

Latest commit

 

History

History
245 lines (191 loc) · 5.26 KB

README.md

File metadata and controls

245 lines (191 loc) · 5.26 KB
Raw

file-manager (TEAM-FALCON-Backend)

A dockerized micro-service for adding, updating, retrieving and deleting files

Quick Start

# Install dependencies
npm i

# Install dev-dependencies
npm i -D

# Serve on localhost:5555 (development)
npm run dev

# Serve on localhost:5555 (production)
npm start

# Test Routes
npm run test

Testing

Files

Routes                            Description
POST :: /v1/files Create a file
GET :: /v1/files Get all files
GET :: /v1/files/:fileId Get a file
UPDATE:: /v1/files/::fileId Update a file
DELETE:: /v1/files/:fileId Delete a file

Create a File

Headers 
Body: form-data
    Key - file(file)
    Value - select file
  • Sample Response
{
    "status": true,
    "message": "File Uploaded",
    "data": null
}

Get all Files

{
    "status": true,
    "message": "Files Found",
    "data": [
        {
            "id": "5e6288bc8c7fec6308a1d499",
            "file": "https://res.cloudinary.com/major-stark/image/upload/v1591884570/files/mark.png"
        },
        {
            "id": "5e6288bc8c7fec6308a1d498",
            "file": "https://res.cloudinary.com/major-stark/image/upload/v1591884570/files/essien.jpeg"
        },
        {
            "id": "5e6288bc8c7fec6308a1d497",
            "file": "https://res.cloudinary.com/major-stark/image/upload/v1591884570/files/saucecode.svg"
        },
        {
            "id": "5e6288bc8c7fec6308a1d496",
            "file": "https://res.cloudinary.com/major-stark/image/upload/v1591884570/files/hng.mp4"
        },
        {
            "id": "5e6288bc8c7fec6308a1d495",
            "file": "https://res.cloudinary.com/major-stark/image/upload/v1591884570/files/doe.gif"
        }
    ]
}

Get a File

{
    "status": true,
    "message": "File Found",
    "data": {
        "id": "5e6288bc8c7fec6308a1d499",
        "file": "https://res.cloudinary.com/major-stark/image/upload/v1591884570/files/mark.png"
    }
}

Update a File

Headers 
Body: form-data
    Key - file(file)
    Value - select file
  • Sample Response
{
    "status": true,
    "message": "File Updated",
    "data": null
}

Delete a File

{
    "status": true,
    "message": "File Deleted",
    "data": null
}

Testing

Users

Routes                            Description
POST :: /v1/users/signup User Signup
POST :: /v1/users/auth User Login

User Signup

{
  "fullName": "Eark Mssien",
  "email": "eark.mssien@hng.com",
  "password": "EarkMssien@20Covid"
}
  • Sample Response
{
  "uid": "28937837gyu82746hfg76",
  "fullName": "Eark Mssien",
  "email": "eark.mssien@hng.com",
  "token": "xxxxxxxxxxxxxxxxxxxxx"
}

User Login

{
  "email": "eark.mssien@hng.com",
  "password": "EarkMssien@20Covid"
}

File structure

+- config/
+----- db.js - handles db connection
+----- multerConfig.js - multer middleware, handles file upload
+- controllers/
+----- files.js - handles file controller
+----- users.js - handles user controller
+- middleware/
+----- async.js - handles async in routes
+----- auth.js - auth middleware
+----- error.js - handles error response
+- models/
+----- File.js - file model
+----- Users.js - user model
+- node_modules/
+- routes/
+----- files.js - handles file controller
+----- users.js - handles user controller
+- utils/
+----- CustomError.js - handles custom error response
+----- response.js
+----- toXML.js
+----- validate.js
+----- verifyLink.js
+- .dockerignore
+- .gitignore
+- Dockerfile
+- README.md
+- docker-compose.yml
+- index.html
+- index.js
+- LICENSE
+- package-lock.json
+- package.json
+- swagger.json
+- wait-for.sh