Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
create-miro-app
Advanced tools
create-miro-app - npm Package Compare versions
Comparing version 1.2.2 to 1.3.0
@@ -1,25 +0,55 @@ | ||
| # Create Miro App | ||
| ## Create a Miro app | ||
| ## How to start: | ||
| ** ℹ Note**: | ||
| - Run `yarn` or `npm install` to install dependencies | ||
| - Run `yarn start` or `npm start` to start developing, you should have a URL | ||
| that looks like this | ||
| - We recommend a Chromium-based web browser for local development with HTTP. \ | ||
| Safari enforces HTTPS; therefore, it doesn't allow localhost through HTTP. | ||
| - All examples use `npm` as a package manager and `npx` as a package runner. \ | ||
| If you prefer, you can install and use equivalent alternatives, such as `yarn` | ||
| or `pnpm`. | ||
| - For more information, visit our | ||
| [developer documentation](https://developers.miro.com). | ||
| ``` | ||
| http://localhost:3000 | ||
| ``` | ||
| ### How to start locally | ||
| - Paste the URL in `App URL` in your app settings | ||
| - open a board & you should see your app in the main toolbar when you click the | ||
| three dots. | ||
| - Run `npm install` to install dependencies. | ||
| - Run `npm start` to start developing. \ | ||
| Your URL should be similar to this example: \ | ||
| ``` | ||
| http://localhost:3000 | ||
| ``` | ||
| - Paste the URL under **App URL** in your | ||
| [app settings](https://developers.miro.com/docs/build-your-first-hello-world-app#step-3-create-your-app-in-miro). | ||
| - Open a board; you should see your app in the app toolbar or in the **Apps** | ||
| panel. | ||
| ## How to build the app: | ||
| ### How to build the app | ||
| Run `yarn run build` or `npm run build` and this will generate a static output | ||
| inside `dist/` which you can host on static hosting service. | ||
| - Run `npm run build`. \ | ||
| This generates a static output inside `dist/`, which you can host on a static hosting | ||
| service. | ||
| ### Folder structure | ||
| <!-- The following tree structure is just an example --> | ||
| ``` | ||
| . | ||
| ├── src | ||
| │ ├── assets | ||
| │ │ └── style.css | ||
| │ ├── app.js // The code for the app lives here | ||
| │ └── index.js // The code for the app entry point lives here | ||
| ├── app.html // The app itself. It's loaded on the board inside the 'appContainer' | ||
| └── index.html // The app entry point. This is what you specify in the 'App URL' box in the Miro app settings | ||
| ``` | ||
| ### About the app | ||
| This app is using [vite](https://vitejs.dev/) so you can check the documentation | ||
| if you want to modify `vite.config.js` configuration if needed. | ||
| This sample app shows how you can | ||
| <!-- describe shortly the purpose of the sample app -->. \ | ||
| Built in React off of the [`create-miro-app`](https://www.npmjs.com/package/create-miro-app) | ||
| React/Typescript starter. | ||
| This app uses [Vite](https://vitejs.dev/). \ | ||
| If you want to modify the `vite.config.js` configuration, see the [Vite documentation](https://vitejs.dev/guide/). |
@@ -1,25 +0,55 @@ | ||
| # Create Miro App | ||
| ## Create a Miro app | ||
| ## How to start: | ||
| ** ℹ Note**: | ||
| - Run `yarn` or `npm install` to install dependencies | ||
| - Run `yarn start` or `npm start` to start developing, you should have a URL | ||
| that looks like this | ||
| - We recommend a Chromium-based web browser for local development with HTTP. \ | ||
| Safari enforces HTTPS; therefore, it doesn't allow localhost through HTTP. | ||
| - All examples use `npm` as a package manager and `npx` as a package runner. \ | ||
| If you prefer, you can install and use equivalent alternatives, such as `yarn` | ||
| or `pnpm`. | ||
| - For more information, visit our | ||
| [developer documentation](https://developers.miro.com). | ||
| ``` | ||
| http://localhost:3000 | ||
| ``` | ||
| ### How to start locally | ||
| - Paste the URL in `App URL` in your app settings | ||
| - open a board & you should see your app in the main toolbar when you click the | ||
| three dots. | ||
| - Run `npm install` to install dependencies. | ||
| - Run `npm start` to start developing. \ | ||
| Your URL should be similar to this example: \ | ||
| ``` | ||
| http://localhost:3000 | ||
| ``` | ||
| - Paste the URL under **App URL** in your | ||
| [app settings](https://developers.miro.com/docs/build-your-first-hello-world-app#step-3-create-your-app-in-miro). | ||
| - Open a board; you should see your app in the app toolbar or in the **Apps** | ||
| panel. | ||
| ## How to build the app: | ||
| ### How to build the app | ||
| Run `yarn run build` or `npm run build` and this will generate a static output | ||
| inside `dist/` which you can host on static hosting service. | ||
| - Run `npm run build`. \ | ||
| This generates a static output inside `dist/`, which you can host on a static hosting | ||
| service. | ||
| ### Folder structure | ||
| <!-- The following tree structure is just an example --> | ||
| ``` | ||
| . | ||
| ├── src | ||
| │ ├── assets | ||
| │ │ └── style.css | ||
| │ ├── app.js // The code for the app lives here | ||
| │ └── index.js // The code for the app entry point lives here | ||
| ├── app.html // The app itself. It's loaded on the board inside the 'appContainer' | ||
| └── index.html // The app entry point. This is what you specify in the 'App URL' box in the Miro app settings | ||
| ``` | ||
| ### About the app | ||
| This app is using [vite](https://vitejs.dev/) so you can check the documentation | ||
| if you want to modify `vite.config.js` configuration if needed. | ||
| This sample app shows how you can | ||
| <!-- describe shortly the purpose of the sample app -->. \ | ||
| Built in React off of the [`create-miro-app`](https://www.npmjs.com/package/create-miro-app) | ||
| React/Typescript starter. | ||
| This app uses [Vite](https://vitejs.dev/). \ | ||
| If you want to modify the `vite.config.js` configuration, see the [Vite documentation](https://vitejs.dev/guide/). |
| import * as React from 'react'; | ||
| import ReactDOM from 'react-dom'; | ||
| import {createRoot} from 'react-dom/client'; | ||
@@ -43,2 +43,4 @@ async function addSticky() { | ||
| ReactDOM.render(<App />, document.getElementById('root')); | ||
| const container = document.getElementById('root'); | ||
| const root = createRoot(container); | ||
| root.render(<App />); |
| { | ||
| "name": "create-miro-app", | ||
| "version": "1.2.2", | ||
| "version": "1.3.0", | ||
| "keywords": [ | ||
@@ -47,3 +47,3 @@ "miro", | ||
| "cross-spawn": "7.0.3", | ||
| "got": "12.0.0", | ||
| "got": "12.1.0", | ||
| "husky": "7.0.4", | ||
@@ -50,0 +50,0 @@ "lint-staged": "12.1.3", |
@@ -1,2 +0,2 @@ | ||
| # Create Miro App | ||
| ## Create a Miro app | ||
@@ -7,7 +7,3 @@ The easiest way to get started with the Miro SDK is by using `create-miro-app`. | ||
| ```sh | ||
| npx create-miro-app@latest | ||
| // or | ||
| yarn create miro-app@latest | ||
| npx create-miro-app | ||
| ``` | ||
@@ -20,10 +16,6 @@ | ||
| ```sh | ||
| npx create-miro-app@latest my-miro-app | ||
| // or | ||
| yarn create miro-app@latest my-miro-app | ||
| npx create-miro-app my-miro-app | ||
| ``` | ||
| ## Options | ||
| ### Options | ||
@@ -35,3 +27,2 @@ | name | description | default | | ||
| If you run `npx create-miro-app@latest` without options, you get an interactive | ||
| prompt. | ||
| If you run `npx create-miro-app` without options, you get an interactive prompt. |
Sorry, the diff of this file is too big to display
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Long strings
Supply chain riskContains long string literals, which may be a sign of obfuscated or packed code.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Long strings
Supply chain riskContains long string literals, which may be a sign of obfuscated or packed code.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.37%
747757
- Lines of code
- increased by0.09%
2277
Worsened metrics
- Number of lines in readme file
- decreased by-25.71%
26
No dependency changes