Skip to content
This repository has been archived by the owner on Mar 26, 2024. It is now read-only.

Slate latest tutorial update #143

Open
wants to merge 30 commits into
base: slate_latest
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
e00c8cb
Initial commit of the SMART on FHIR tutorial in it's final repository…
kpshek Nov 13, 2016
6a6212c
tutorial changes
Nov 13, 2016
124646a
new client id
Nov 13, 2016
a4bba28
Fix link to code console
dennispatterson Nov 14, 2016
58fe4f4
better loading indicator
Nov 16, 2016
c355ad6
hm, actual call auth oops
Nov 16, 2016
6ce2cfb
Hide loading on error.
Nov 16, 2016
c8a3396
Hide header until app is loaded.
Nov 16, 2016
da157d6
revert tutorial changes
Nov 16, 2016
343bcba
update "without ruby" instructions
Nov 16, 2016
7bad79d
revert client id change
mjhenkes Nov 17, 2016
2f9430b
Use es6-shim to pull in Array.prototype.find implementation for IE 10…
Nov 18, 2016
0d3d656
Fix NPE when valueQuantity is undefined
Nov 18, 2016
c03b24d
Update example app to pull in the latest fhir-client, and fhir-client…
kolkheang Jul 12, 2017
372f7ab
Update README and add SMART Health IT section (#25)
kolkheang Jul 25, 2017
ed54084
Add MPage integration details to tutorial app and include relevant fi…
zplata Oct 6, 2017
31f6257
Update fhir client library to latest distributed file (#31)
zplata Oct 6, 2017
18f46d7
Create a separate launch file for SMART Health IT Sandbox (#32)
kolkheang Oct 6, 2017
a748122
Fix licensing artifacts to reflect the Apache License 2.0. (#36)
kpshek Nov 3, 2017
5f621e8
Add standalone launch section for Patient Access Workflow (#37)
kolkheang Nov 9, 2017
7cc7e16
Update SMART Health IT section with updated instructions
kolkheang May 23, 2018
9ed01ee
Address PR review comments
kolkheang Jun 4, 2018
1ab26f3
Display birth date as-is rather than thru a JS Date object (fixes #52)
kpshek Jun 4, 2018
cd229bd
Update Travis config to build against Ruby 2.4 and 2.5
kpshek Jun 4, 2018
b634dda
Add clarification around standalone launch support
daliboz Jan 8, 2020
0229c8e
Tutorial links instructions correction (#105)
xiaoningmzhang Feb 3, 2020
ba25247
fix spacing, clarify chart selection
daliboz Jun 11, 2020
81b6971
Use new public sandbox root URL (#119)
MaxPhilips Aug 26, 2020
bb99763
Remove unnecessary .github folder imported by slate
chenyixuan625 Dec 2, 2020
a12cb62
Update cerner-smart-embeddable-lib to 1.4.0
chenyixuan625 Dec 17, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/bug.md

This file was deleted.

5 changes: 0 additions & 5 deletions .github/ISSUE_TEMPLATE/config.yml

This file was deleted.

5 changes: 0 additions & 5 deletions .github/PULL_REQUEST_TEMPLATE.md

This file was deleted.

42 changes: 0 additions & 42 deletions .github/workflows/build.yml

This file was deleted.

41 changes: 0 additions & 41 deletions .github/workflows/deploy.yml

This file was deleted.

50 changes: 0 additions & 50 deletions .github/workflows/dev_deploy.yml

This file was deleted.

22 changes: 0 additions & 22 deletions .github/workflows/publish.yml

This file was deleted.

10 changes: 10 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
sudo: false

language: ruby

rvm:
- 2.4
- 2.5

cache: bundler
script: bundle exec middleman build
13 changes: 13 additions & 0 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Copyright 2017 Cerner Innovation, Inc

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
91 changes: 21 additions & 70 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,82 +1,33 @@
<p align="center">
<img src="https://raw.githubusercontent.com/slatedocs/img/main/logo-slate.png" alt="Slate: API Documentation Generator" width="226">
<br>
<a href="https://github.com/slatedocs/slate/actions?query=workflow%3ABuild+branch%3Amain"><img src="https://github.com/slatedocs/slate/workflows/Build/badge.svg?branch=main" alt="Build Status"></a>
<a href="https://hub.docker.com/r/slatedocs/slate"><img src="https://img.shields.io/docker/v/slatedocs/slate?sort=semver" alt="Docker Version" /></a>
</p>
# SMART Tutorial

<p align="center">Slate helps you create beautiful, intelligent, responsive API documentation.</p>
Run the tutorial here:
https://cerner.github.io/smart-on-fhir-tutorial

<p align="center"><img src="https://raw.githubusercontent.com/slatedocs/img/main/screenshot-slate.png" width=700 alt="Screenshot of Example Documentation created with Slate"></p>

<p align="center"><em>The example above was created with Slate. Check it out at <a href="https://slatedocs.github.io/slate">slatedocs.github.io/slate</a>.</em></p>

Features
Description
------------
The SMART tutorial is intended to help developers quickly create an example smart app, register it with Cerner's code console, and test it against Cerner's sandbox. It is a [Slate](https://github.com/lord/slate) site hosted through GitHub Pages and includes a small example app in the source folder.

* **Clean, intuitive design** — With Slate, the description of your API is on the left side of your documentation, and all the code examples are on the right side. Inspired by [Stripe's](https://stripe.com/docs/api) and [PayPal's](https://developer.paypal.com/webapps/developer/docs/api/) API docs. Slate is responsive, so it looks great on tablets, phones, and even in print.

* **Everything on a single page** — Gone are the days when your users had to search through a million pages to find what they wanted. Slate puts the entire documentation on a single page. We haven't sacrificed linkability, though. As you scroll, your browser's hash will update to the nearest header, so linking to a particular point in the documentation is still natural and easy.

* **Slate is just Markdown** — When you write docs with Slate, you're just writing Markdown, which makes it simple to edit and understand. Everything is written in Markdown — even the code samples are just Markdown code blocks.

* **Write code samples in multiple languages** — If your API has bindings in multiple programming languages, you can easily put in tabs to switch between them. In your document, you'll distinguish different languages by specifying the language name at the top of each code block, just like with GitHub Flavored Markdown.

* **Out-of-the-box syntax highlighting** for [over 100 languages](https://github.com/jneen/rouge/wiki/List-of-supported-languages-and-lexers), no configuration required.

* **Automatic, smoothly scrolling table of contents** on the far left of the page. As you scroll, it displays your current position in the document. It's fast, too. We're using Slate at TripIt to build documentation for our new API, where our table of contents has over 180 entries. We've made sure that the performance remains excellent, even for larger documents.

* **Let your users update your documentation for you** — By default, your Slate-generated documentation is hosted in a public GitHub repository. Not only does this mean you get free hosting for your docs with GitHub Pages, but it also makes it simple for other developers to make pull requests to your docs if they find typos or other problems. Of course, if you don't want to use GitHub, you're also welcome to host your docs elsewhere.

* **RTL Support** Full right-to-left layout for RTL languages such as Arabic, Persian (Farsi), Hebrew etc.

Getting started with Slate is super easy! Simply press the green "use this template" button above and follow the instructions below. Or, if you'd like to check out what Slate is capable of, take a look at the [sample docs](https://slatedocs.github.io/slate/).

Getting Started with Slate
Getting Started
------------------------------

To get started with Slate, please check out the [Getting Started](https://github.com/slatedocs/slate/wiki#getting-started)
section in our [wiki](https://github.com/slatedocs/slate/wiki).

We support running Slate in three different ways:
* [Natively](https://github.com/slatedocs/slate/wiki/Using-Slate-Natively)
* [Using Vagrant](https://github.com/slatedocs/slate/wiki/Using-Slate-in-Vagrant)
* [Using Docker](https://github.com/slatedocs/slate/wiki/Using-Slate-in-Docker)

Companies Using Slate
---------------------------------

* [NASA](https://api.nasa.gov)
* [Sony](http://developers.cimediacloud.com)
* [Best Buy](https://bestbuyapis.github.io/api-documentation/)
* [Travis-CI](https://docs.travis-ci.com/api/)
* [Greenhouse](https://developers.greenhouse.io/harvest.html)
* [WooCommerce](http://woocommerce.github.io/woocommerce-rest-api-docs/)
* [Dwolla](https://docs.dwolla.com/)
* [Clearbit](https://clearbit.com/docs)
* [Coinbase](https://developers.coinbase.com/api)
* [Parrot Drones](http://developer.parrot.com/docs/bebop/)
* [Scale](https://docs.scaleapi.com/)
### Prerequisites

You can view more in [the list on the wiki](https://github.com/slatedocs/slate/wiki/Slate-in-the-Wild).
You're going to need:

Questions? Need Help? Found a bug?
--------------------
- GitHub account

If you've got questions about setup, deploying, special feature implementation in your fork, or just want to chat with the developer, please feel free to [start a thread in our Discussions tab](https://github.com/slatedocs/slate/discussions)!

Found a bug with upstream Slate? Go ahead and [submit an issue](https://github.com/slatedocs/slate/issues). And, of course, feel free to submit pull requests with bug fixes or changes to the `dev` branch.

Contributors
--------------------

Slate was built by [Robert Lord](https://lord.io) while at [TripIt](https://www.tripit.com/). The project is now maintained by [Matthew Peveler](https://github.com/MasterOdin) and [Mike Ralphson](https://github.com/MikeRalphson).
License
------------------------------
Copyright 2017 Cerner Innovation, Inc

Thanks to the following people who have submitted major pull requests:
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

- [@chrissrogers](https://github.com/chrissrogers)
- [@bootstraponline](https://github.com/bootstraponline)
- [@realityking](https://github.com/realityking)
- [@cvkef](https://github.com/cvkef)
http://www.apache.org/licenses/LICENSE-2.0

Also, thanks to [Sauce Labs](http://saucelabs.com) for sponsoring the development of the responsive styles.
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
5 changes: 0 additions & 5 deletions deploy.sh
Original file line number Diff line number Diff line change
Expand Up @@ -93,17 +93,14 @@ main() {

commit_title=`git log -n 1 --format="%s" HEAD`
commit_hash=` git log -n 1 --format="%H" HEAD`

#default commit message uses last title if a custom one is not supplied
if [[ -z $commit_message ]]; then
commit_message="publish: $commit_title"
fi

#append hash to commit message unless no hash flag was found
if [ $append_hash = true ]; then
commit_message="$commit_message"$'\n\n'"generated from commit $commit_hash"
fi

previous_branch=`git rev-parse --abbrev-ref HEAD`

if [ ! -d "$deploy_directory" ]; then
Expand All @@ -119,7 +116,6 @@ main() {

if git ls-remote --exit-code $repo "refs/heads/$deploy_branch" ; then
# deploy_branch exists in $repo; make sure we have the latest version

disable_expanded_output
git fetch --force $repo $deploy_branch:$deploy_branch
enable_expanded_output
Expand Down Expand Up @@ -202,7 +198,6 @@ restore_head() {
else
git symbolic-ref HEAD refs/heads/$previous_branch
fi

git reset --mixed
}

Expand Down
24 changes: 24 additions & 0 deletions source/example-smart-app/health.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<title>Example-SMART-App</title>

<!--
Temporarily disable cerner-smart-embeddable-lib
<link rel='stylesheet' type='text/css' href='./lib/css/cerner-smart-embeddable-lib-1.4.0.min.css'>
-->
</head>
<body>
<!-- Required JS files to enable this page to embed within an MPage -->
<!--
Temporarily disable cerner-smart-embeddable-lib
<script src='https://cdnjs.cloudflare.com/ajax/libs/babel-polyfill/6.26.0/polyfill.min.js'></script>
<script src='./lib/js/cerner-smart-embeddable-lib-1.4.0.min.js'></script>
-->

<img src="./src/images/batman.gif" alt="Batman">
<p>Healthy!</p>
</body>
</html>
Loading