Giter VIP home page Giter VIP logo

restappcards's Introduction

Miro REST App Cards

This sample app demonstrates the use of the Miro REST API's App Card endpoints. It makes use of each of the available CRUD (create, read, update, delete) methods to add and manage App Cards on a Miro board. It also provides an example of creating Miro App Cards from external structured data (.CSV file) and embedding a Miro board via direct link.

Miro capabilities covered in this sample app:

  • Miro App Card items
  • Create App Card API, GET App Card API, Update App Card API, DELETE App Card API
  • Import structured data into Miro
  • Miro Live Embed

Prerequisites:

Dependencies:

How to start:

  • Clone or download repo
  • cd to root folder
  • Run npm install to install dependencies
  • Create a .env file in the root folder, and set the following variables:
boardId={MIRO_BOARD_ID}
oauthToken={MIRO_ACCESS_TOKEN}
  • From your desired Miro board, grab the board ID from the URL and paste it into the .env boardId variable (above)

In this example, we will host the project locally at PORT 8000.

How to run the project

  • Run nodemon app.js to run the project
  • Your express server console should reflect "The web server has started on port 8000" (or the port of your choice)

Folder structure

.
├── package.json <-- The app dependencies which are installed in "How to start"
└── app.js <-- The main Node.js script to run the Express server and render our Handlebars app
└── .env <-- File where you are storing your sensitive credentials
└── node_modules <-- Node modules that are installed based on dependencies
└── views
      └── createCard.hbs <-- Handlebars file to render app card creation page
      └── deleteCard.hbs <-- Handlebars file to render app card deletion page
      └── updateCard.hbs <-- Handlebars file to render app card update page
      └── uploadCard.hbs <-- Handlebars file to render app card upload page
      └── viewCard.hbs <-- Handebars file to render app card list page
      └── home.hbs <-- main Handlebars file to render universal/root rendering
      └── layouts
            └── main.hbs <-- the Handlebars app itself

About the app

This is a backend app built on Node.js and Express.js, with Handlebars.js for rendering.

restappcards's People

Contributors

bishopwm avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.