Skip to content

feat(): add dynamic image sizing using sharp #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 22, 2025
Merged

feat(): add dynamic image sizing using sharp #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The project is built using MSW and can be run directly on a local machine or in
The framework is written in TypeScript and can :

- Serve data from static files (JSON or text)
- Serve media : Images and Videos
- Serve media : Images (which can be dynamically resized using url parameters) and Videos
- Serve markdown files
- Be used to write and test AWS Lambda Functions
- Use custom middleware to transform input/output
Expand Down Expand Up @@ -253,6 +253,15 @@ and
http://localhost:8000/api/videos/placeholder.mp4
```

#### 9.1 Resizing images

Images should be saved in PNG format. To get an image of any required size, pass the pixel width and height in the url parameters.
Note: both a height AND a width need to be passed for the image to resize otherwise the default size is used.

```
http://localhost:8000/api/images/placeholder.png?width=300&height=500
```

### 10. Markdown

Markdown can be served from the markdown folder in src/resources/markdown and supports code highlighting. Note the url doesn't need to include .md
Expand Down
Loading