{"id":15371118,"url":"https://github.com/mraible/angular-book","last_synced_at":"2025-10-15T04:33:50.596Z","repository":{"id":37961268,"uuid":"274988764","full_name":"mraible/angular-book","owner":"mraible","description":"The Angular Mini-Book","archived":false,"fork":false,"pushed_at":"2025-01-27T14:35:37.000Z","size":127025,"stargazers_count":7,"open_issues_count":5,"forks_count":7,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-23T10:32:29.915Z","etag":null,"topics":["angular","angular-material","bootstrap","kotlin","oidc","spring-boot","typescript"],"latest_commit_sha":null,"homepage":"https://www.infoq.com/minibooks/angular-mini-book/","language":"TypeScript","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/mraible.png","metadata":{"files":{"readme":"README.adoc","changelog":"CHANGELOG.adoc","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}},"created_at":"2020-06-25T18:33:39.000Z","updated_at":"2025-01-27T14:35:40.000Z","dependencies_parsed_at":"2024-04-29T15:40:37.167Z","dependency_job_id":"0fe317a9-d94c-4254-bf91-80267a5963a2","html_url":"https://github.com/mraible/angular-book","commit_stats":{"total_commits":277,"total_committers":4,"mean_commits":69.25,"dds":0.4296028880866426,"last_synced_commit":"1912b09317981180990a664fa5d49df2113b3b07"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mraible%2Fangular-book","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mraible%2Fangular-book/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mraible%2Fangular-book/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mraible%2Fangular-book/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mraible","download_url":"https://codeload.github.com/mraible/angular-book/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241056990,"owners_count":19901893,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["angular","angular-material","bootstrap","kotlin","oidc","spring-boot","typescript"],"created_at":"2024-10-01T13:45:29.145Z","updated_at":"2025-10-15T04:33:50.486Z","avatar_url":"https://github.com/mraible.png","language":"TypeScript","readme":"= Angular Mini-Book\n\nimage::https://github.com/mraible/angular-book/workflows/Book%20CI/badge.svg[link=\"https://github.com/mraible/angular-book/actions\",alt=\"Actions Status\"]\n\nThis is an awesome book. It's written in AsciiDoc and compiles to HTML, PDF, and EPUB using the\nhttp://asciidoctor.org/docs/asciidoctor-gradle-plugin/[Asciidoctor Gradle plugin].\n\n== Installing\n\n----\nnpm run setup\n----\n\n== Building\n\nTo convert this book to HTML and EPUB, run the following command:\n\n----\nnpm run build\n----\n\n* Open _build/asciidoc/html5/index.html_ in your browser to see the generated HTML file.\n* Open _build/asciidoc/pdf-prepress/index.pdf_ to see the 6x9\" printable PDF file.\n* Open _build/asciidoc/pdf-screen/index.pdf_ to see the downloadable 8.5x11\" PDF file.\n* Open _build/asciidoc/epub3/index.epub_ in iBooks to see the generated EPUB file.\n\nTo generate a static site using Antora, run the following command:\n\n npm run build:site\n\n== Sweet Authoring Experience\n\nIf you'd like a very pleasant authoring experience, the project provides build files that make it possible. First of all,\nyou'll need to run `gradlew` once. After running it once, you can run `./gradlew watch` to watch for any changes and\nrecompile files as you save them.\n\nTo have a similar awesome experience (watch and auto-reload) in your browser, install https://nodejs.org/[Node.js] on your machine.\n\nAfter installing Node, you can run the following command to install development tools (like http://www.browsersync.io/[Browsersync]).\n\n----\nnpm install\n----\n\nTIP: You will only need to run this command when dependencies change in `package.json`.\n\nNow you can run the following command:\n\n----\nnpm start\n----\n\nThis will start two daemons:\n\n. Gradle, which will watch the file system and rebuild the HTML version continuously using Asciidoctor\n. BrowserSync, which will serve the updated HTML version all of the time and make it available over HTTP\n\nThanks to this, you'll have a constantly up to date HTML version available in your browser while editing.\n\nSimilarly, you can run the following command to continuously watch the file system and rebuild the static site:\n\n----\nnpm run watch:site\n----\n\n== Update Dependencies\n\nTo update the dependencies in `build.gradle`, run:\n\n----\n./gradlew useLatestVersions\n----\n\nTo update the dependencies in `package.json`, install https://www.npmjs.com/package/npm-check-updates[npm-check-updates] and run it:\n\n----\nnpm i -g npm-check-updates\nncu\n----\n\n== Releasing/Publishing\n\nThis project includes GitHub action workflows to build and publish the book (PDF, EPUB, HTML). To trigger this, you have two options:\n\n* Run the following script: `npm run release`\n* Use GitHub's UI to create the release from your book repository\n\nOnce completed, the publish workflow will attach the generated files to the release page.\n\nThe benefit of the release npm script is that the version will be updated automatically in the `package.json` and `version.txt` files. The version will be reflected in the generated files because the version in `version.txt` is used as the Gradle project version when building the book.\n\nNote that in order for the release npm script to work, you'll need to make sure that a `GITHUB_TOKEN` environment variable is available, as explained in https://github.com/release-it/release-it/blob/master/docs/environment-variables.md[release-it's documentation].\n\n== Deploy to Netlify\n\nTo deploy this repository to https://www.netlify.com/[Netlify], create an account and log in.\n\n. Select **New site from Git**\n. Select your Git provider\n. Select your repository\n. Select the branch to deploy\n. Build command: `npm run build:site`\n. Publish directory: `public/`\n. Click **Deploy site**\n\nYour site should take less than a minute to deploy, depending on the size of your book.\n\n== Netlify Preview\n\nThis repository is using a `netlify.toml` configuration file to build and publish the static site to Netlify. You can see the result at https://angular-book.org.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmraible%2Fangular-book","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmraible%2Fangular-book","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmraible%2Fangular-book/lists"}