{"id":36825268,"url":"https://github.com/microprofile/microprofile-tutorial-ui","last_synced_at":"2026-01-12T14:04:05.828Z","repository":{"id":292232555,"uuid":"962847799","full_name":"microprofile/microprofile-tutorial-ui","owner":"microprofile","description":"The UI for MicroProfile Tutorial","archived":false,"fork":false,"pushed_at":"2025-06-17T21:19:54.000Z","size":451,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":26,"default_branch":"main","last_synced_at":"2025-06-17T22:27:25.694Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/microprofile.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-08T19:05:22.000Z","updated_at":"2025-06-17T21:18:58.000Z","dependencies_parsed_at":"2025-05-08T20:44:15.908Z","dependency_job_id":null,"html_url":"https://github.com/microprofile/microprofile-tutorial-ui","commit_stats":null,"previous_names":["microprofile/microprofile-tutorial-ui"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/microprofile/microprofile-tutorial-ui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microprofile%2Fmicroprofile-tutorial-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microprofile%2Fmicroprofile-tutorial-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microprofile%2Fmicroprofile-tutorial-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microprofile%2Fmicroprofile-tutorial-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microprofile","download_url":"https://codeload.github.com/microprofile/microprofile-tutorial-ui/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microprofile%2Fmicroprofile-tutorial-ui/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28340253,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T12:22:26.515Z","status":"ssl_error","status_checked_at":"2026-01-12T12:22:10.856Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-12T14:04:05.458Z","updated_at":"2026-01-12T14:04:05.728Z","avatar_url":"https://github.com/microprofile.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"= MicroProfile Documentation UI\n\n// External URLs:\n:url-antora-ui-default: https://gitlab.com/antora/antora-ui-default\n:url-git: https://git-scm.com\n:url-git-dl: {url-git}/downloads\n:url-gulp: http://gulpjs.com\n:url-opendevise: https://opendevise.com\n:url-nodejs: https://nodejs.org\n:url-nvm: https://github.com/nvm-sh/nvm\n:url-nvm-install: {url-nvm}#installing-and-updating\n:url-microprofile-tutorial-ui: https://github.com/microprofile/microprofile-tutorial-ui\n:url-microprofile-tutorial-ui-actions: {url-microprofile-tutorial-ui}/actions\n:url-microprofile-tutorial-ui-release: {url-microprofile-tutorial-ui}/releases/tag/latest\n:url-microprofile-tutorial: https://github.com/microprofile/microprofile-tutorial\n:url-microprofile-tutorial-live: https://microprofile.github.io/microprofile-tutorial/\n\nThis project is forked from {url-antora-ui-default}[Antora Default UI] as per their instructions.\n\n== Prerequisites\n\nTo build this project and preview it locally, you need the following software on your computer:\n\n* {url-git}[git] (command: `git`)\n* {url-nodejs}[Node.js] (commands: `node` and `npm`)\n* {url-gulp}[Gulp CLI] (command: `gulp`)\n\n=== git\n\nFirst, make sure you have Git installed.\n\n $ git --version\n\nIf not, {url-git-dl}[download and install] the Git package for your system.\n\n=== Node.js\n\nNext, make sure that you have Node.js installed (which also provides `npm`).\n\n $ node --version\n\nIf this command fails with an error, you don't have Node.js installed.\nWhile you can install Node.js from the official packages, we strongly recommend that you use {url-nvm}[nvm] (Node Version Manager) to manage your Node.js installation(s).\nFollow the {url-nvm-install}[nvm installation instructions] to set up nvm on your machine.\n\nOnce you've installed nvm, open a new terminal and `cd` into the project folder and install Node.js using the following command:\n\n $ nvm install\n\nThis will basically install the Node.js version defined in the `.nvmrc` file of this project.\n\n=== Gulp CLI\n\nYou'll need the Gulp command-line interface (CLI) to run the build.\nThe Gulp CLI package provides the `gulp` command.\nYou can install the Gulp CLI globally using the following command:\n\n $ npm install -g gulp-cli\n\nVerify the Gulp CLI is installed by running:\n\n $ gulp --version\n\nNow that you have the prerequisites installed, you can build the project.\n\n== Build the project\n\nUse `npm` to install the project's dependencies inside the project.\nIn your terminal, `cd` into the project folder and execute the following command:\n\n $ npm install\n\nThis command installs the dependencies listed in [.path]_package.json_ into the [.path]_node_modules/_ folder inside the project.\nThis folder does not get included in the UI bundle and should _not_ be committed to the source control repository.\n\n== Preview the UI\n\nThe files in the [.path]_preview-src/_ folder provide the sample content that allow you to see the UI in action.\nIn this folder, you'll primarily find pages written in AsciiDoc.\nThese pages provide a representative sample and kitchen sink of content from the real site.\n\nTo build the UI and preview it in a local web server, run the `preview` command:\n\n $ gulp preview\n\nYou'll see a URL listed in the output of this command:\n\n....\n[12:00:00] Starting server...\n[12:00:00] Server started http://localhost:5252\n[12:00:00] Running server\n....\n\nNavigate to this URL to preview the site locally.\n\nWhile this command is running, any changes you make to the source files will be instantly reflected in the browser.\nThis works by monitoring the project for changes, running the `preview:build` task if a change is detected, and sending the updates to the browser.\n\nPress kbd:[Ctrl+C] to stop the preview server and end the continuous build.\n\n== Package the UI\n\nIf you need to package the UI so you can use it to generate the documentation site locally, run the following command:\n\n $ gulp bundle\n\nIf any errors are reported by lint, you'll need to fix them.\n\nWhen the command completes successfully, the UI bundle will be available at [.path]_build/ui-bundle.zip_.\nYou can if necessary point Antora at this bundle using the `--ui-bundle-url` command-line option.\nOr in `local-antora-playbook.yml` for Antora Author Mode, set the `ui.bundle.url` property to `../microprofile-tutorial-ui/build/ui-bundle.zip`.\n\n== Deploy the project\n\nThis is already done automatically by {url-microprofile-tutorial-ui-actions}[Github Actions].\nIt will generate an UI bundle tagged `latest` which is available as {url-microprofile-tutorial-ui-release}[Latest UI bundle].\nThis bundle is in turn already referenced as `ui.bundle.url` property in `antora-playbook.yml` configuration file of {url-microprofile-tutorial}[MicroProfile Tutorial Playbook].\n\nThe live site can be found at {url-microprofile-tutorial-live}[{url-microprofile-tutorial-live}].\n\n== GitHub Pages Deployment\n\nThis project can also be built and deployed directly to GitHub Pages, which allows you to host the UI documentation directly from this repository.\n\n=== Building for GitHub Pages\n\nTo build the UI for GitHub Pages locally, run:\n\n $ gulp github-pages\n\nThis will generate the complete site in the `public` directory, ready for GitHub Pages deployment.\n\n=== Automatic Deployment\n\nThe project includes a GitHub Actions workflow that automatically builds and deploys the site to GitHub Pages whenever changes are pushed to the main branch. The workflow:\n\n1. Checks out the repository\n2. Sets up Node.js\n3. Installs dependencies\n4. Builds the site using the `github-pages` task\n5. Deploys the built site to GitHub Pages\n\nTo enable GitHub Pages for your fork of this repository:\n\n1. Go to your repository's Settings tab\n2. Navigate to Pages in the left sidebar\n3. Under \"Source\", select \"GitHub Actions\"\n\nOnce deployed, your site will be available at `https://[username].github.io/microprofile-tutorial-ui/` or at a custom domain if you configure one in the GitHub Pages settings.\n\nThis approach allows you to maintain both the UI bundle for Antora and a standalone documentation site from the same repository.\n\n== Development with Dev Containers / GitHub Codespaces\n\nThis project includes Dev Container configuration, making it easy to develop using Visual Studio Code Dev Containers or GitHub Codespaces. The development environment comes pre-configured with:\n\n* Node.js LTS\n* Gulp CLI for build automation\n* GitHub Actions extension for workflow management\n* AsciiDoctor extension for documentation editing\n\n=== Using GitHub Codespaces\n\nTo start developing using GitHub Codespaces:\n\n1. Go to your repository on GitHub\n2. Click the green \"Code\" button\n3. Select the \"Codespaces\" tab\n4. Click \"Create codespace on main\"\n\nThis will create a cloud-based development environment with all dependencies pre-installed.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicroprofile%2Fmicroprofile-tutorial-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicroprofile%2Fmicroprofile-tutorial-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicroprofile%2Fmicroprofile-tutorial-ui/lists"}