{"id":19010112,"url":"https://github.com/pushfor/typeddocker","last_synced_at":"2025-04-22T23:01:44.780Z","repository":{"id":144006485,"uuid":"106750211","full_name":"Pushfor/typeddocker","owner":"Pushfor","description":"Docker + Yarn + Electron + Gulp + TypeScript + Squirrel + Golden-Layout + Angular 4 + React","archived":false,"fork":false,"pushed_at":"2017-11-02T12:32:19.000Z","size":149,"stargazers_count":6,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-17T14:38:04.797Z","etag":null,"topics":["angular","angular4","docker","electron","express","golden-layout","gulp","istanbul","jasmine","nginx","react","squirrel","typescript","vanilla-typescript","yarn"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Pushfor.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,"zenodo":null}},"created_at":"2017-10-12T22:06:28.000Z","updated_at":"2022-12-28T02:34:16.000Z","dependencies_parsed_at":null,"dependency_job_id":"1e8a4b1b-cc4a-42f0-b879-954889a79d4e","html_url":"https://github.com/Pushfor/typeddocker","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/Pushfor%2Ftypeddocker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pushfor%2Ftypeddocker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pushfor%2Ftypeddocker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Pushfor%2Ftypeddocker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Pushfor","download_url":"https://codeload.github.com/Pushfor/typeddocker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250337904,"owners_count":21414103,"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","angular4","docker","electron","express","golden-layout","gulp","istanbul","jasmine","nginx","react","squirrel","typescript","vanilla-typescript","yarn"],"created_at":"2024-11-08T19:09:55.385Z","updated_at":"2025-04-22T23:01:44.767Z","avatar_url":"https://github.com/Pushfor.png","language":"CSS","readme":"# Typeddocker\n\n[![Build Status](https://travis-ci.org/Pushfor/typeddocker.svg?branch=master)](https://travis-ci.org/Pushfor/typeddocker)\n\nThis repository is still under development and not ready for reuse. \n\n\u003e Docker + Yarn + Electron + Gulp + TypeScript\n\n## Goal\n\n * Boilerplate to allow building complex TypeScript applications served as a vendor indepentant website or a desktop application\n\n## It is not...\n\n * an actual application\n * thing that force you to some UI framework\n * uncommon problem\n * full web stack - you should use some varnish, nginx, elb in front\n\n## Ingridients\n \n * Core technologies\n   * Docker - to ship it vendor independent \n   * TypeScript - ES6/7/8 + types + decorators + interfaces\n   * Sass - most popular CSS D.R.Y. language\n   * HTML - because it's there\n * Framework / Engine \n   * Express (Node 8) - just serve, no magic\n   * Electron - windows, osx, linux\n   * Vanilla\n     * because [React vs Angular vs Vue 2017](https://medium.com/unicorn-supplies/angular-vs-react-vs-vue-a-2017-comparison-c5c52d620176)\n     * because you can choose one or few or all\n\n## Usage\n\n```bash\ncd docker\n./restart.deamon.sh\n```\n\n## Contribute\n\n * fork -\u003e code -\u003e test -\u003e PR -\u003e merge -\u003e repeat\n * be constructive\n \n## Structure\n\n```\n/docker\n  /compose\n    /app\n      /src\n        /apps\n          /angular - TBD, example, deployed to public/angular\n          /electron - TBD\u003c electron node process\n          /express - express server app\n          /react - TBD, example, deployed to public/react\n          /vanilla - example, deployed to public\n          /vue - example, deployed to public/vue\n        /node_modules - not checked in, shared for all projects\n        gulpfile.js\n        package.json\n        tsconfig.json\n        yarn.lock\n      /Dockerfile\n    /nginx - tbd\n    .env - to be excluded from the repo\n    .env.json - to be exluded from the repo\n/volumes\n```\n\n## Use cases\n\n * App is composed of:\n   * `backend` which serves files and expose microservices\n   * `frontend` which can be one or many applicaitons using one or many frameworks\n     * applications are distributed across folders\n     * applicaitons share cookies/localstorage because of the same domain/process\n\n## To Do\n\n[x] Docker\n[x] Gulp\n[x] Sass\n[ ] Vanilla\n[x] Angular 4\n[x] Angular 4 AOT\n[ ] React\n[ ] Vue\n[ ] Jasmine\n[ ] Travis\n[ ] Protractor\n[ ] Istanbul\n\n### Web application\n```\nI====================================I\nI Docker                             I\nI               |-------------|---\u003e serve\nI               |   Express   |      I\nI               |-------------|\u003c--\u003e microservices\nI                      ^             I\nI                      |             I\nI |------|  1-n |-------------|      I\nI | Gulp |-----\u003e| HTML/JS/CSS |      I\nI |------|      |-------------|      I\nI     ^                              I\nI     |                              I\nI |--------------------------------| I\nI | Source: TypeScript, Scss, HTML | I\nI |--------------------------------| I\nI====================================I\n```\n\n * Shipped as docker container\n * Source is tranformed on startup by gulp tasks\n * Dist files are served by express\n * Microservices are exposed by express\n   * Thanks to express we can do serverside rendering\n\n### Electron application\n```\nI====================================I\nI Electron executab                  I\nI               |-------------|      I\nI          /---\u003e|     Main    |\u003c--\u003e microservices\nI          |    |-------------|      I\nI          |                         I\nI          |    |-------------|      I\nI          |    |    Render   |---\u003e serve\nI          |/--\u003e| HTML/JS/CSS |      I\nI          |    |-------------|      I\nI==========|=========================I\n           |         \nI==========|=========================I    \nI Docker   |                         I       \nI       |------|                     I\nI       | Gulp |                     I\nI       |------|                     I\nI          ^                         I\nI          |                         I\nI |--------------------------------| I\nI | Source: TypeScript, Scss, HTML | I\nI |--------------------------------| I\nI====================================I\n\n```\n\n * Source is tranformed on build by gulp tasks\n * Dist files are served by electron main process\n * Microservices are exposed by main process (ipc)\n * Shipped as executable (.exe, .app) or update package (.zip, .nupkg)\n\n## Solution\n\n```\nI====================================I\nI Docker               |---------|   I\nI                    /-| Express |   I\nI         / \\       /  |---------|   I\nI     web/desktop -\u003c                 I\nI         \\ /       \\                I     |----------|  \nI          ^         \\---------------------| Electron |  \nI          |                         I     |----------|  \nI    |-------------|                 I\nI    | HTML/JS/CSS |                 I\nI    |-------------|                 I\nI          ^                         I\nI          |                         I\nI       |------|                     I\nI       | Gulp |                     I\nI       |------|                     I\nI          ^                         I\nI          |                         I\nI |--------------------------------| I\nI | Source: TypeScript, Scss, HTML | I\nI |--------------------------------| I\nI====================================I\n```\n\n * Docker\n   * cares about enironment and requirements\n * TypeScript, Scss, HTML\n   * shared source files  \n * Gulp\n   * produce dist files from source files\n   * can watch source file changes to update dist (dev mode)\n   * can run karma/jasmine/protractor/cucumber\n   * startup express or builds electron distibutable and packages it\n * Express\n   * Serves static files from dist folder\n     * HTML\n     * JavaScript (es5)\n     * CSS3\n     * SVG, fonts, PNG\n   * Expose microservices\n     * via `websockets`\n * Electron\n   * Serves static files from build folder\n     * as above\n   * Expose microservices\n     * use electron `ipc` protocol   \n\n## Licence\n\nMIT License\n\nCopyright (c) 2017-present, Pushfor Limited.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpushfor%2Ftypeddocker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpushfor%2Ftypeddocker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpushfor%2Ftypeddocker/lists"}