File Flow

About the Project

File Flow is a lightweight NestJS backend server that allows you to effortlessly upload, access, and manage files. With its intuitive API and robust features, File Flow streamlines file handling for developers and users alike.

This projects aims to be a template or guidance for projects that require handling file uploads on Nest JS projects. Additionally, for academic purposes, the project implements CQRS for better integration with other projects that follow a Domain-Driven Design architecture. Out of the box, this project include an endpoint for uploading, downloading, deleting or updating icons. However, this endpoint can be used indiscriminately with any kind of file of any size.

It's meant that each group of resources (images, icons, files, etc.) has its own controller, but it can be used (out of the box) with any type of file.

Is Nest JS good for file handling?

The implementation of this project turned out to be really convenient, fast and smooth. In addition, downloading or uploading files are I/O Bound operations, so JavaScript can handle them without any major problems other than speed at which data can be read or written to the disk.

Getting Started

Installation

Clone the repo

git clone https://github.com/aleiva17/upc-buddy

Install NodeJS packages in the cloned file
```
npm install
```
Access .env and set the storage directory path:
```
STORAGE_DIRECTORY_PATH=/here/goes/your/path
```

Run one of the following commands depending on your use case

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

To access the Swagger documentation, open the following link:
```
http://localhost:3000/api/docs
```

Built With

Nest JS
Nest CQRS Module
Open Api Module
Configuration Module

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'feat:Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Aleiva - @aleiva17 - aleiva1700@gmail.com

aleiva17/file-flow