This project is a simple implementation of an image upload app.
You need to have the following installed on your local development system before you can go ahead with this project (except you want to develop using docker).
yarn install
For developmental purpose, run the following commands
npm run start:dev
To run test, run below command
npm run test
For production, run below command
npm run start:prod
For docker, run the following commands
docker-compose up -d
This project is structured in modules. Images module
The Images module contains information about an image. The files in this module include images controller, entity, routes, validations and interfaces.
The features of this project include the following.
- Upload an image and created two (200x200) and (300x300) thumbnails
- Get an image and its associated thumbnails
- Get all images
The API documentation for testing the endpoints is located here