{"id":13941296,"url":"https://github.com/brikis98/hello-startup-site","last_synced_at":"2025-09-02T15:31:14.486Z","repository":{"id":24796705,"uuid":"28210613","full_name":"brikis98/hello-startup-site","owner":"brikis98","description":"The website and mobile app for the book \"Hello, Startup\" by Yevgeniy Brikman","archived":false,"fork":false,"pushed_at":"2024-06-27T20:36:00.000Z","size":90201,"stargazers_count":89,"open_issues_count":8,"forks_count":28,"subscribers_count":15,"default_branch":"gh-pages","last_synced_at":"2024-12-22T22:07:07.949Z","etag":null,"topics":["book","entrepreneurship","hello-world","startup","startup-resources"],"latest_commit_sha":null,"homepage":"http://www.hello-startup.net/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/brikis98.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2014-12-19T02:18:23.000Z","updated_at":"2024-06-27T20:36:03.000Z","dependencies_parsed_at":"2024-06-27T23:26:00.755Z","dependency_job_id":"1e3c5dbf-f773-4519-8a86-ed13b3371fea","html_url":"https://github.com/brikis98/hello-startup-site","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brikis98%2Fhello-startup-site","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brikis98%2Fhello-startup-site/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brikis98%2Fhello-startup-site/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brikis98%2Fhello-startup-site/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brikis98","download_url":"https://codeload.github.com/brikis98/hello-startup-site/tar.gz/refs/heads/gh-pages","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231797617,"owners_count":18428058,"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":["book","entrepreneurship","hello-world","startup","startup-resources"],"created_at":"2024-08-08T02:01:15.844Z","updated_at":"2024-12-29T23:38:46.507Z","avatar_url":"https://github.com/brikis98.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"Hello, Startup Website\n==================\n\nThis is the website and mobile app for [Hello, Startup: A Programmer's Guide to\nBuilding Products, Technologies, and Teams](https://www.hello-startup.net), an\nO'Reilly book by [Yevgeniy Brikman](https://www.ybrikman.com).\n\nStatus\n==================\n\n* The *Hello, Startup* website is available at https://www.hello-startup.net.\n* Contributions, especially to the list of\n  [Startup Resources](https://www.hello-startup.net/#resources), are welcome via\n  pull request (see instructions below).\n* The mobile app version is currently on pause as the market doesn't seem big\n  enough for it.\n\nRunning the website\n==================\n\n1. Install [grunt.js](http://gruntjs.com/)\n2. Install [jekyll](http://jekyllrb.com/)\n3. `npm start`\n4. http://localhost:4000\n\nThe `grunt` command runs `grunt watch`, which will watch for changes in the\nbackground and recompile everything as necessary. Jekyll is a bit slow, so it\ncan take ~5 seconds for your changes to be visible.\n\nRunning with Docker\n==================\n\nAs an alternative to installing Ruby, Jekyll, and Grunt, if you're a user of\n[Docker](https://www.docker.com/), you can run a Docker image of\nhello-startup-site that has all the dependencies already setup for you.\n\n1. `git clone` this repo\n2. `docker-compose up`\n3. Go to `http://localhost:4000` to test\n\nArchitecture\n==================\n\n* [jekyll](http://jekyllrb.com/): used to assemble static HTML from the HTML\n  fragments in `_layouts`, `_includes`, `_resources`, and `_data`.\n* [grunt.js](http://gruntjs.com/): used to concatenate and minify CSS and\n  JavaScript.\n* [PhoneGap](http://phonegap.com/): used to package up the static HTML as\n  iOS and Android apps.\n* [GitHub Pages](https://pages.github.com/): for hosting the website.\n* [CloudFlare](https://www.cloudflare.com/): free SSL and CDN.    \n* [Bootstrap](http://getbootstrap.com/): for CSS, layout, general theme.\n* [Font Awesome](http://fortawesome.github.io/Font-Awesome/): for icons.\n\nThe Startup Resources\n==================\n\nThe [Startup Resources](https://www.hello-startup.net/#resources) are generated\nfrom [YAML](http://www.yaml.org/) data files in the `_data` folder (see the\n[Jekyll Data Files](http://jekyllrb.com/docs/datafiles/) documentation for\nmore info). These resources are a work in progress and I welcome contributions\nvia [pull request](https://help.github.com/articles/using-pull-requests/).\n\nEach YAML file contains the information for one type of resource. For example,\n`deployment.yml` contains all the resources related to deploying code.\n\nThe basic format is:\n\n```yaml\nname: \"Name for this resource\"\ndescription: \"Brief description of this resource.\"\nicon: \"The name of one of the Font Awesome icons to represent this resource.\"\ntype: \"one of: products, technologies, or teams\"\ncategories:\n  - id: \"a-unique-id-for-this-category\"\n    name: \"Human readable name for the category\"\n    sites: # List of websites for this category\n      - name: \"Website #1\"\n        url: \"https://www.website-number-one.com/\"\n        image: \"screenshot1.jpg\" # 800x400 screenshot under images/resources\n        description: \"A brief description of website #1\"\n      - name: \"Website #2\"\n        url: \"https://www.website-number-two.com/\"\n        image: \"screenshot2.jpg\" # 800x400 screenshot under images/resources\n        description: \"A brief description of website #2\"\n```\n\nSee the `_data` folder for lots of examples.\n\nRunning the mobile app\n==================\n\n*Note: mobile app development has been put on pause and may not work any more*\n\n1. Install [PhoneGap](http://phonegap.com/)\n2. Install the [PhoneGap Developer App](http://app.phonegap.com/) on your\n   computer and the mobile app for your phone.\n3. Run `grunt` as explained in the \"Running the website\" instructions. This will\n   assemble all of the HTML.\n4. Add a new project to the PhoneGap Developer App by adding the `mobile`\n   folder (which has `config.xml`).\n5. At the bottom of the PhoneGap Developer App, it should tell you that the\n   project is running and the URL. Connect to this URL in the PhoneGap mobile\n   app on your phone.\n6. If you want to build the app for real, use\n   [PhoneGap Build](https://build.phonegap.com).\n\nMaking PhoneGap and Jekyll work together\n==================\n\nBoth PhoneGap and Jekyll require a specific folder structure, and those are not\nmutually compatible. To make this all work using the same content in the same\nrepo, I've used a bit of a hack with symlinks:\n\n1. PhoneGap's `config.xml` and `index.html` are in the `mobile` folder.\n2. Everything else is in the normal Jekyll locations (e.g. `_includes`, `_layouts`,\n   `javascripts`, `stylesheets`). All of these files get compiled into the normal\n   Jekyll output folder (`_site`).\n3. I've added symlinks from the `mobile/www` folder to `_site`. Therefore, if\n   you point PhoneGap at the `mobile` folder, it will see the folder structure\n   it expects.\n4. Since `_site` is normally generated by the Jekyll build process, you don't\n   usually check it in. However, I had to in this case, or the symlinks won't\n   work, which causes an error when GitHub Pages tries to build the site.\n   Therefore, I've checked in a few placeholder files that ensure the folders\n   we symlink to exist.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrikis98%2Fhello-startup-site","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrikis98%2Fhello-startup-site","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrikis98%2Fhello-startup-site/lists"}