FSH Online is a web application for authoring FHIR Shorthand (FSH) and running the SUSHI compiler on the authored FSH directly in a web browser. It also runs the GoFSH decompiler to translate FHIR definitions into FSH. It is available on https://fshschool.org/FSHOnline/.
This project was bootstrapped with Create React App.
To run the project locally, Node.js must be installed on the user's system.
In order to install all the required dependencies for the project, clone the repository and run the following command:
npm installOnce the dependencies are installed, the application can be run in development mode by running the following command:
npm startOpen http://localhost:3000 to view it in the browser. The page will reload if you make edits. Lint errors will appear in the console.
FSH Online supports easily adding FHIR Shorthand examples that can be viewed in the editor. All examples are kept in the FSHOnline-Examples repo, and FSH authors are encouraged to submit example FSH files to the FSHOnline-Examples repo.
The following NPM tasks are useful in development.
To run the project's tests, run the following command:
npm testThis will launch the test runner in the interactive watch mode. For more information, see the section about running tests in the Create React App documentation.
To run the linter for the project, run the following command:
npm run lintAny issues will be listed. Some issues can be automatically fixed by lint. In order to fix these issues, run the following command:
npm run lint-fixTo run the prettier code formatting, run the following command:
npm run prettierTo build the app for production, run the following command:
npm run buildThis will bundle the project in production mode and optimize the build for the best performance. The build will be output to the build folder. The build is minified and the filenames include the hashes.
The build can be used to deploy the application. For more information, see the section about deployment in the Create React App documentation.
To serve the built application locally for testing, run the following command:
npm run serve-buildThis will serve the built application from the build directory. It will be served on port 8000. You can access it at the following URL: http://localhost:8000/FSHOnline/.
Note: this is a one-way operation. Once you eject, you can’t go back!
To eject this project, run:
npm run ejectIf you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
To learn more about FHIR Shorthand (FSH), check out the specification. To learn more about SUSHI, check out the documentation and to learn more about GoFSH, visit the documentation. For other resources and tools to use with FHIR Shorthand, check out FSH School.
To learn React, check out the React documentation. You can learn more in the Create React App documentation as well.
Copyright 2019 Health Level Seven International
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.