From ef303ee1c2c9fcfa268ac1e2d0abde3f92ee223e Mon Sep 17 00:00:00 2001 From: HamsterCoder Date: Fri, 19 Jan 2024 16:50:06 +0100 Subject: [PATCH] [Docs] Update project readme a little bit. --- README.md | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f7f98a6..e01e4a9 100644 --- a/README.md +++ b/README.md @@ -16,10 +16,44 @@ More lessons will be gradually added. Starting a vite dev server: ``` -npm install +npm ci npm run dev ``` +Starting storybook: + +``` +npm run storybook +``` + +Checking bundle size: + +``` +npx vite-bundle-visualizer +``` + +### Images + +This project uses images from unsplash as well as original images. + +- Original images must be high quality 1000x1000 pixels JPEGS. +- Original images are stored in `public/assets-raw-orig/` +- They are then compressed for production with mozjpeg and sharp, to create jpg and webp assets. + +Whenever new images are added run: + +``` +node compress-images.js +node convert-images.js +``` + +- Unsplash images are currently manually resized to 1000x1000, and the compressed. +- Unsplash images are stored in `public/assets-raw/` + +``` +node compress-images.js +``` + ## Future plans Further more, there are plans to grow this into a generic intrument for making language courses through writing lessons in json-style configs. However, the following issues must be adressed to achieve this: