Skip to main content

Setting Up File Upload

If you forgot to initialize service-file-upload when creating your new Stencil app, you can still add it using the following command:

stencil g service-file-upload
# or 
stencil g fu

This command installs all necessary dependencies for service-file-upload.

Note: For better safety, execute:

npm install
or
yarn install

Setup Dependent Services

This example depends on MinIO as an S3-based storage engine to store the uploaded files. A docker-compose.yml file has been provided at the root of this project which sets up a Minio instance for your use. You can start the instance by running:

docker-compose up -d

Setting up the Environment

Copy the example environment file to create your own .env file:

cp env-example .env

Setting up File Upload Manually

To manually set up the file-upload functionality, you need to register the FileUploadModule module in your module which can be imported from the @samagra-x/stencil package.

Prerequisites:

npm i @samagra-x/stencil

For example:

// other imports 
import { FileUploadModule } from '@samagra-x/stencil';

@Module({
  imports: [FileUploadModule],
  // other configs
})
export class AppModule {}

Via the CLI

To set up file-upload functionality automatically via the CLI, simply run the following command:

stencil add service-file-upload

Running the App

# development
yarn run start
# or
npm run start

# watch mode
yarn run start:dev
# or
npm run start:dev

# production mode
yarn run start:prod
# or
npm run start:prod

Test

# unit tests
yarn run test
# or
npm run test

# e2e tests
yarn run test:e2e
# or
npm run test:e2e

# test coverage
yarn run test:cov
# or 
npm run test:cov

File Upload Instructions

To upload single or multiple files, follow the steps below:

Endpoint

POST /files/upload-files

Query Parameters

  • destination: Specifies the target directory for the uploaded files. Example: /files/upload-files?destination=uploads.

Request Body

The request should include the following form-data fields:

  • file: The file(s) to be uploaded.
  • filename: The corresponding filename(s) for the uploaded file(s).

Note: Ensure that the number of files and filenames are the same and listed in the correct order.

Example

To upload files to the uploads directory:

POST /files/upload-files?destination=uploads

In the form-data:

  • Add the files under the field name file.
  • Add the filenames under the field name filename.

File Download Instructions

To download a file, follow the steps below:

Endpoint

GET /files/download/:destination

Parameters

  • destination: The relative path to the file within the uploads directory. For example, if the file is located at your_project/uploads/resume.

Example

To download a file located at your_project/uploads/resume:

GET /files/download/resume

Note: The default base directory for downloads is /uploads, located at the root level of your project directory (same level as the node_modules directory).

By following these steps, you can efficiently handle file uploads and downloads within your project.

Contents

Edit this page