Getting Started

How to run

This is a Spring Boot application. To run it execute the main method of com.miro.spelchecker.SpelcheckerApplication. Or:

Run with SSL (for local execution)

./mvnw clean spring-boot:run -Dspring-boot.run.profiles=ssl,local

Build and run without SSL (for execution on hosting provider)

./mvnw clean package
./mvnw spring-boot:run -Dspring-boot.run.profiles=local

Sample GET Request

/spellcheck?lang=en-US&text=hollo%20tere

Sample Output

{ "_type":"SpellCheck", "flaggedTokens":[ { "offset":0, "token":"hollo", "type":"UnknownToken", "suggestions":[ { "suggestion":"hello", "score":0.8609481730888449 }, { "suggestion":"hollow", "score":0.695921414953466 }, { "suggestion":"holly", "score":0.6189701890901528 } ] }, { "offset":6, "token":"tere", "type":"UnknownToken", "suggestions":[ { "suggestion":"there", "score":0.8609481730888449 }, { "suggestion":"tree", "score":0.695921414953466 } ] } ] }

 ℹ Note:

• We recommend a Chromium-based web browser for local development with HTTP.
  Safari enforces HTTPS; therefore, it doesn't allow localhost through HTTP.
• For more information, visit our developer documentation.

How to start locally

• Run npm i 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.
• Open a board; you should see your app in the app toolbar or in the Apps panel.

How to build the app

• Run npm run build.
  This generates a static output inside dist/, which you can host on a static hosting service.

Folder structure

.
├── src
│  ├── assets
│  │  └── style.css
│  ├── app.tsx      // The code for the app lives here
│  └── index.ts    // 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 sample app provides you with boilerplate setup and configuration that you can further customize to build your own app.

Built using create-miro-app.

This app uses Vite.
If you want to modify the vite.config.js configuration, see the Vite documentation.