Joshwawo / backend-local-cloud

lOCAL CLOUD

This is an API, to have something similar to Google Cloud locally, so you can later complement it with a frontend.

Setup project

Install the project dependencies.

  //using npm
  npm install
  
  //using pnpm
  pnpm install

Open .env-example and copy its content into a new file named .env, then set the correct value for HOME_CLOUD_STORAGE.

Build the project.

  //using npm
  npm run build
  
  //using pnpm
  pnpm build

Run the project

  //using npm
  npm run start
  
  //using pnpm
  pnpm star

API Reference

Get Directory

GET /api/content/path?

Return what is in the current directory.

How to navigate between folders?

In a URL, the slash "/" is used to separate the different sections of a web address and to indicate the path to a file or directory on the web server. That is why in this case we opted to use "--", later changed to "//" to access the folder in Windows or "/" in Linux.

Creation of folders

Create folder

POST /api/dir/path?

Body	Type	Description
name	string	Required

Example

To create folders is a simple way, let's follow the path above, within this we want to create a folder.

POST /api/dir/amigos--pollos--familly

File Upload

  POST /api/upload/path?

Body	Type	Description
file	file	Form Data

Example

POST /api/upload/amigos--pollos--familly

Download Files

GET /api/download/path?

Example

GET /api/download/amigos--pollos--familly--gus.png

View Media files

POST /api/img/path?

It is not limited to images and videos, you can also view PDFs among many multimedia files.

Example

POST /api/img/amigos--pollos--familly--gus.png

Delete Files

DELETE /api/delete/path?

Example

DELETE /api/delete/amigos--pollos--familly--gus.png

Rename Files

PUT /api/rename/path?

Body	Type	Description
name	string	Raw Json

Example

PUT /api/rename/amigos--pollos--familly--gus.png