search

gematik / codfsh

codfsh is a VS Code Extension to support compilation and validation of FHIR profile definitions. Short Hand files (.fsh) can be compiled and validated easily with Sushi and HAPI validator
Other
6 stars 1 forks source link

Enhanced codfsh Extension Setup and Local Installation Guide #28

Open SvenSommer opened 11 months ago

SvenSommer commented 11 months ago

Summary of Changes

This pull request introduces significant enhancements to the codfsh extension setup process and adds a comprehensive guide for local installation. The key changes include:

  1. Devcontainer Integration: Added a .devcontainer folder to the root of the repository, which includes a Dockerfile and a preconfigured codfsh-config.yaml. This setup streamlines the development environment setup by providing a Docker container with all necessary tools and configurations for the codfsh extension.

  2. Local Installation Guide: Created a new document, install_without_devcontainer.md, which provides detailed instructions for users who prefer a local installation without using a devcontainer. This guide covers the installation of Java JRE, dotnet SDK, npm, SUSHI, firely.terminal, and the HAPI FHIR validator.

  3. README Update: Updated the README file to include information about the new devcontainer setup and a link to the Local Installation Guide. This update ensures that users are aware of the simplified setup process and have clear instructions for both containerized and local setups.

Motivation and Context

The motivation behind these changes is to enhance the user experience and ease the setup process for the codfsh extension. By providing a preconfigured devcontainer, we aim to offer a seamless and consistent development environment setup. Additionally, the Local Installation Guide serves as a valuable resource for users who opt for a manual setup on their local machines.

Testing

The changes have been tested by setting up the codfsh extension in both the devcontainer environment and a local environment following the new guide. The tests ensured that all tools and dependencies work correctly and that the extension functions as expected in both scenarios.

Documentation

I believe these enhancements will significantly improve the setup experience for codfsh users and contribute to a more efficient development workflow.