File Storage Service

File storage service is Microservice build to securely store your files to the Google Cloud bucket.

Installation

File Storage Service is written in TypeScript and NodeJS, using MySQL as its primary database, make sure you have the necessary command lines tools installed for NestJS.

Please refer to NestJS CLI for more details

Follow the step to install the necessary modules for the project.

Step 1: Install Node Modules

npm install

Step 2: Create a build

npm run build

Step 3: Configure the environment file

Please refer to the .env.sample for sample file and create .env file with the necessary configuration.

Database Migration

File storage service uses MySQL database. To run the migrations create a ormconfig.json file in the root directory with database configurations. Please refer to the ormconfig.sample.json for sample file.

Run the following command to run migrations.

npx typeorm migration:run

Usage

Run the following command to start the server.

npm run start

API Collection

Swagger UI is configured for the project. You can visit localhost:port/docs to view the Swagger UI screen.

Enter the username and password which is mentioned inside the .env file.