Filemanager

Learning how to work with IBM Cloud Object Storage and MulterS3 to store files.

📌 Table of Contents

• Features
• Installation
• Getting Started
• Build
• Technologies

🚀 Features

• Files Upload to IBM Cloud Object Storage

👷 Installation

You need to install Node.js and Yarn first, then in order to clone the project via HTTPS, run this command:

git clone git@github.com:cunhaedu/filemanager.git

Install dependencies

yarn install

Or

npm install

Create your environment variables based on the examples of .env.example

cp .env.example .env

Setup a database

Install Postgres to create a database and create a database, then you should modify the .env with your credentials

Create an account in IBM and configure a IBM Cloud Object Storage bucket

For tests, you can create a free account to use the IBM COS. After create an account, create and configure a bucket, then, get your credentials and put them in .env.

🏃 Getting Started

Run the transactions in order to configure the database schema:

yarn typeorm migration:run

Run the following command in order to start the application in a development environment:

yarn dev:server

🏃 Build

Run the following command in order to convert the .ts file to .js file in a folder called dist:

yarn build

Run the following command in order to start the application in a production environment:

yarn start

🚀 Technologies

This project use the following technologies:

• IBM Cloud Object Storage
• multer-s3
• Typescript