Challenge Overview
This challenge is to integrate showdown.js to a Contentful app that we're currently building. Over the last few weeks, we've run a variety of challenges around Contentful - a popular API first CMS service. We started off with a F2F node.js micro-service for Contentful and then followed it up with a challenge to do POST operations to post objects in Contentful. Our last challenge was an open ended exploration challenge to create a web app that would access the Contentful features through a web UI - the only requirement being the frontend does not deal with Contentful tokens. We'll be providing the winning submission from the last challenge in our challenge assets and would like to build upon it with the actual functionality our client wants.
Requirements
Our client wants to use Contentful to store what they call as their DRA - Digital Reference Architecture documentation. These are essentially a collection of markdown files which they want to serve using Contentful and be able to create and edit files in real time via a web application. They would like to be able to preview the files as they are creating/ editing these in the web application. We believe showdown.js is a good option to provide the real time editing and preview capabilties for markdown files in a web application. We would like our markdown files to have support
A) Ability to support varioust types of markdown tags
B) Preview and render images
C) Be able to save a file automatically in Contentful while it's being created/ edited (Auto save)
D) Further, we want users to be able to comment on files and discuss them similar to how Github Issues works.
The web application ( to be built) as well as wrapper node services (already provided) for will finally run on Heroku. You are free to make changes to the provided wrapper node services as required. Just make sure to document and explain your changes as part of your submission.
To see showdown.js in action, check out this demo application
Provided Challenge Assets
- Winning submission from last challenge providing Contentful backend services and a simple web app bulit using Bootstrap
- Sample .md files used by client