Skip to content

Commit

Permalink
[Docs] Update project readme a little bit.
Browse files Browse the repository at this point in the history
  • Loading branch information
HamsterCoder committed Jan 19, 2024
1 parent 4d36911 commit ef303ee
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit ef303ee

Please sign in to comment.