{"id":51031025,"url":"https://github.com/dreamfactorysoftware/dreamfactory-book-v2","last_synced_at":"2026-06-22T00:30:56.165Z","repository":{"id":40236214,"uuid":"359999211","full_name":"dreamfactorysoftware/dreamfactory-book-v2","owner":"dreamfactorysoftware","description":null,"archived":false,"fork":false,"pushed_at":"2026-02-18T02:22:35.000Z","size":29751,"stargazers_count":3,"open_issues_count":7,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2026-02-18T06:50:23.224Z","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/dreamfactorysoftware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-04-21T01:37:32.000Z","updated_at":"2026-02-18T02:22:36.000Z","dependencies_parsed_at":"2024-11-20T19:39:49.040Z","dependency_job_id":null,"html_url":"https://github.com/dreamfactorysoftware/dreamfactory-book-v2","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dreamfactorysoftware/dreamfactory-book-v2","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreamfactorysoftware%2Fdreamfactory-book-v2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreamfactorysoftware%2Fdreamfactory-book-v2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreamfactorysoftware%2Fdreamfactory-book-v2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreamfactorysoftware%2Fdreamfactory-book-v2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dreamfactorysoftware","download_url":"https://codeload.github.com/dreamfactorysoftware/dreamfactory-book-v2/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreamfactorysoftware%2Fdreamfactory-book-v2/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34630753,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-21T02:00:05.568Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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-06-22T00:30:55.496Z","updated_at":"2026-06-22T00:30:56.154Z","avatar_url":"https://github.com/dreamfactorysoftware.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Getting Started with DreamFactory\n\n[![Netlify Status](https://api.netlify.com/api/v1/badges/f60d78a3-0f5f-4819-bfa4-308d70154a02/deploy-status)](https://app.netlify.com/sites/frosty-goldberg-9f8df9/deploys)\n\n## Configuring Your Development Environment\n\n_The Following Instructions are based on an installation in an Ubuntu Virtual Machine, but this project can be run in any 64bit OS_\n\n### Installing Hugo\n\nWe'll use a Vagrant Ubuntu 18.04 VM to run the book website locally:\n\n```\n$ git@github.com:dreamfactorysoftware/dreamfactory-book-v2.git\n$ vagrant init hashicorp/bionic64\n```\n\nNext, open `Vagrantfile` and open guest port `1313`, pointing it to the host port of `8080` (or any other open port):\n\n```\nconfig.vm.network \"forwarded_port\", guest: 1313, host: 8080\n```\n\nNow start the VM:\n\n```\n$ vagrant up\n```\n\nNext, install the *extended* version of Hugo. This is important. Go [here](https://github.com/gohugoio/hugo/releases) and find the download that looks like `hugo_extended_0.83.1_Linux-64bit.tar.gz`. Of course the version number will be different, but the string `extended` should be in the file name, and you should download the Linux version.\n\n```\n$ vagrant ssh\n$ sudo apt update\n```\n\nNext, download the latest **extended** version of Hugo from [here](https://github.com/gohugoio/hugo/releases). Save this to the virtual machine shared volume. Then `ssh` into your vm, create a hugo directory `mkdir hugo`, move the file there, and extract it using:\n\n```\ntar -xf hugo_extended_0.82.0_Linux-64bit.tar.gz\n```\n\nThen install Hugo to your `/usr/bin` directory:\n\n```\nsudo install hugo /usr/bin\n```\n\nYou should see the +extended suffix when checking the version with:\n\n```\nhugo version\nhugo v0.83.1-5AFE0A57+extended linux/amd64 BuildDate=2021-05-02T14:38:05Z VendorInfo=gohugoio\n```\n\n### Regarding node and npm\n\nYou will need a Node version above 6 for the required npm packages. An easy way to update is using the `n` package:\n\n```\nnpm cache clean -f\nsudo npm install -g n\nsudo n stable\n```\n\n### Cloning and Booting up the Web Server\n\nReturn to your VM home directory and clone the book repository:\n\n```\ngit clone git@github.com:dreamfactorysoftware/dreamfactory-book-v2.git\n```\n\nEnter the project directory and get local copies of the project using:\n\n```\ngit submodule update --init --recursive\n```\n\nFinally, use npm to install the necessary packages:\n\n```\nsudo npm install -D autoprefixer\nsudo npm install -D postcss-cli\nsudo npm install -D postcss\n```\n\nStart the Hugo server using `hugo server --bind 0.0.0.0` and go to http://localhost:8080 on your host machine to see the site. \n\n## DreamFactory Styling:\n\nThe scss variables can be changed in `assets/scss/_variables_project.scss`.\n\n* Primary Color: `$primary: #6666CC;`\n* Tip Success Color: `$success: #41BA83;`\n* Tip Warning Color: `$warning: #E7C000;`\n* Tip Danger Color `$danger: #CC0202;`\n\nThe font is lato:\n\n```\n$google_font_name: \"Lato\";\n$google_font_family: \"Lato:300,300i,400,400i,700,700i\";\n```\n\n### Favicons\n\n* Favicons are located in static/favicons\n\n### Footer\n\n* Changes can be made in the partials folder `themes/docsy/layouts/partials/footer.html`\n\n### Homepage\n\n* The homepage is in `_index.html`, located in the root of the `content/en` directory. You can use the following layout to structure your page:\n\n```\n/// Hero Section (Full View Height)\n{{\u003c blocks/cover title=\"Main Title\" height=\"full\" color=\"\u003ccolor\u003e\u003c/color\u003e\" \u003e}}\nhtml here\n{{\u003c /blocks/cover \u003e}}\n\n\n{{% blocks/lead color=\"primary\" %}}\n // Information Blurb\n{{% /blocks/lead %}}\n\n{{\u003c blocks/section color=\"dark\" \u003e}}\n{{% blocks/feature title=\"\u003cTitle\u003e\" %}}\n // Left Third Content\n{{% /blocks/feature %}}\n\n\n{{% blocks/feature icon=\"\u003cfont awesome icon\u003e\" title=\"\u003ctitle\u003e\" url=\"\u003curl\u003e\" %}}\n // Center Third Content\n{{% /blocks/feature %}}\n\n\n{{% blocks/feature icon=\"\u003cfont awesome icon\u003e\" title=\"\u003ctitle\u003e\" url=\"\u003curl\u003e\" %}}\n// Right Third Content\n{{% /blocks/feature %}}\n\n{{\u003c /blocks/section \u003e}}\n```\n\n### Images\n\n* Images should be stored in the `static` folder, and then can be called from the path after that. For example: `\u003cimg src=“/images/02/lb-ha-diagram.png” width=“800”\u003e`\n\n* Note the homepage background image defaults to a darker gradient being applied to the image. This can be removed by deleting the `td-overlay--dark` class from cover.html\n\n### Internal Links\n\n* Use the automatically generated slugs when linking to other pages:\n`[Chapter 1. Introducing REST and DreamFactory](./introducing-rest-and-dreamfactory/)`\nSlugs are hyphonated lowercase versions of the folder names.\n\n### Linking to the gihub repository\n\n* Make changes in the config.toml file git github_repo (docs repo) and github_project_repo (dreamfactory itself)\n\n### Logos\n\n* Logos need to be in svg format and saved to themes/docsy/assets/icons.\nNote that you will most likely need to play around with the height, width, and viewbox in the `\u003csvg\u003e` tag in the inspector until you have something thats fits nicely.\n\n### Making Alerts\n\n```\n{{\u003c alert \u003e}}This is an alert.{{\u003c /alert \u003e}}\n{{\u003c alert title=\"Note\" \u003e}}This is an alert with a title.{{\u003c /alert \u003e}}\n{{% alert title=\"Note\" %}}This is an alert with a title and **Markdown**.{{% /alert %}}\n{{\u003c alert color=\"success\" \u003e}}This is a successful alert.{{\u003c /alert \u003e}}\n{{\u003c alert color=\"warning\" \u003e}}This is a warning.{{\u003c /alert \u003e}}\n{{\u003c alert color=\"warning\" title=\"Warning\" \u003e}}This is a warning with a title.{{\u003c /alert \u003e}}\n```\n\n### Navbar Changes\n\n* Navbar changes (internal links)can be made by going to the relevant root _index.md file (eg content/en/about) and adding a title and linkTitle.\n\n```\n---\ntitle: Getting Started With DreamFactory\nlinkTitle: Home\nmenu:\n  main:\n    weight: 10\n---\n```\n\n`weight` corresponds to the order of tabs from the left.\n\n* External hyperlinks can be added to the navbar by adding the following in the config.toml file\n\n```\n[[menu.main]]\n    name = \"\u003ctitle of link\u003e\"\n    weight = 50 \n    url = \"https://\u003csite\u003e\"\n    pre = \"\u003ci class='fas fa-link'\u003e\u003c/i\u003e\"\n```\n\n`pre` will show on the left of the link, `post` will show on the right of the link\n\n* The default navbar setting on the homepage is to match the background color until you scroll down 1 viewport, this can be removed by deleting the `td-navbar-cover` class from navbar.html\n\n## Hosting on Netlify\n\n* On netlify, after choosing \"New site from Git\" and selecting your repo, you will need to apply the following deploy settings:\n1. The build command should specify `cd themes/docsy \u0026\u0026 git submodule update -f --init \u0026\u0026 cd ../.. \u0026\u0026 hugo`\n2. In advanced build settings you will need two new variables:\n\n```\nHUGO_VERSION 0.83.1\nHUGO_ENV production\n```\n\n* Make sure that your package.json has the following dependencies in it:\n\n```\n\"devDependencies\": {\n    \"autoprefixer\": \"^9.8.6\",\n    \"postcss-cli\": \"^8.0.0\",\n    \"postcss\": \"^8.0.0\"\n  }\n```\n\n`postcss` and `postcss-cli` should be set to versions 8 or higher.\n\n## Troubleshooting\n\nAs you run the website locally, you may run into the following error:\n\n```\n➜ hugo server\n\nINFO 2021/01/21 21:07:55 Using config file: \nBuilding sites … INFO 2021/01/21 21:07:55 syncing static files to /\nBuilt in 288 ms\nError: Error building site: TOCSS: failed to transform \"scss/main.scss\" (text/x-scss): resource \"scss/scss/main.scss_9fadf33d895a46083cdd64396b57ef68\" not found in file cache\n```\n\nThis error occurs if you have not installed the extended version of Hugo.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdreamfactorysoftware%2Fdreamfactory-book-v2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdreamfactorysoftware%2Fdreamfactory-book-v2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdreamfactorysoftware%2Fdreamfactory-book-v2/lists"}