Skip to content
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.

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

Simplify <Image /> component #102

Merged
merged 1 commit into from
Apr 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v20.5.0
v20
31 changes: 16 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,12 @@ A set of components and utilities to work faster with [DatoCMS](https://www.dato

## Table of Contents

- [Features](#features)
- [Installation](#installation)
- [Development](#development)
- [vue-datocms](#vue-datocms)
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Installation](#installation)
- [Development](#development)
- [What is DatoCMS?](#what-is-datocms)

## Features

Expand Down Expand Up @@ -49,26 +52,24 @@ Helpers:
npm install vue
# Then install vue-datocms
npm install vue-datocms
```
## Development

This repository contains a number of examples. You can use them to locally test your changes to the package:
# Demos

- [Vue 3 + TypeScript + Vite](examples/vite-typescript-vue3/) ([running demo](https://vue-datocms-vite-typescript-vue3-example.vercel.app/))
- [Query subscription](examples/query-subscription/) ([running demo](https://vue-datocms-query-subscription-example.vercel.app/))
- [Site search](examples/site-search/) ([running demo](https://vue-datocms-site-search-example.vercel.app/))
For fully working examples take a look at our [examples directory](https://github.com/datocms/vue-datocms/tree/master/examples).

To use them, follow this recipe starting from the vue-datocms folder:
Live demo: [https://vue-datocms-example.netlify.com/](https://vue-datocms-example.netlify.com/)

```
## Development

This repository contains a number of demos/examples. You can use them to locally test your changes.

```bash
npm install
cd examples/vite-typescript-vue3
npm run setup
cd examples
npm setup
npm run dev
```

It's not recommended to leverage `npm link` to use the working copy from the examples: that would complicate the structure of each example and it would not replicate a real-world installation. Therefore the `npm run setup` available in each example packs and installs the local copy of `vue-datocms` via a `.tgz` compressed tarball.

<!--datocms-autoinclude-footer start-->
-----------------
# What is DatoCMS?
Expand Down
21 changes: 21 additions & 0 deletions biome.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"$schema": "https://biomejs.dev/schemas/1.6.3/schema.json",
"organizeImports": {
"enabled": true
},
"linter": {
"enabled": true,
"rules": {
"recommended": true
}
},
"formatter": {
"enabled": true,
"indentStyle": "space"
},
"javascript": {
"formatter": {
"quoteStyle": "single"
}
}
}
File renamed without changes.
File renamed without changes.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 24 additions & 0 deletions examples/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"name": "vite-typescript-vue3",
"version": "0.0.0",
"private": true,
"type": "module",
"scripts": {
"setup": "npm uninstall react-datocms && rm -rf ./node_modules/.cache && cd .. && rm -f react-datocms.tgz && npm ci && npm run build && mv -f $(npm pack 2>&1 | tail -1) react-datocms.tgz && cd examples && npm install --save ../react-datocms.tgz && npm install;",
"dev": "vite",
"build": "vue-tsc --noEmit && vite build",
"preview": "vite preview"
},
"dependencies": {
"@datocms/cma-client-browser": "*",
"@unhead/vue": "^1.9.4",
"vue": "^3.2.37",
"vue-datocms": "file:../react-datocms.tgz"
},
"devDependencies": {
"@vitejs/plugin-vue": "^3.2.0",
"typescript": "^4.9.5",
"vite": "^3.2.8",
"vue-tsc": "^0.40.13"
}
}