{"id":24656945,"url":"https://github.com/rob2d/greedux","last_synced_at":"2025-06-30T11:03:02.031Z","repository":{"id":57247324,"uuid":"93907759","full_name":"rob2d/greedux","owner":"rob2d","description":"A clean workspace/workflow template supporting React, Redux, Material-UI, Live Reload as well as Deployable Express server to create maintainable and modular front-end web apps.","archived":false,"fork":false,"pushed_at":"2018-12-02T00:50:50.000Z","size":3470,"stargazers_count":17,"open_issues_count":1,"forks_count":6,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-03T11:59:51.098Z","etag":null,"topics":["deployable","express","gulp","javascript","jss","modular","nodejs","react","react-jss","redux","yeoman"],"latest_commit_sha":null,"homepage":"","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/rob2d.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-10T01:09:14.000Z","updated_at":"2024-01-16T16:28:04.000Z","dependencies_parsed_at":"2022-08-24T16:50:40.012Z","dependency_job_id":null,"html_url":"https://github.com/rob2d/greedux","commit_stats":null,"previous_names":["rob2d/generator-react-redux-gulp"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rob2d/greedux","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rob2d%2Fgreedux","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rob2d%2Fgreedux/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rob2d%2Fgreedux/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rob2d%2Fgreedux/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rob2d","download_url":"https://codeload.github.com/rob2d/greedux/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rob2d%2Fgreedux/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260450044,"owners_count":23010998,"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":["deployable","express","gulp","javascript","jss","modular","nodejs","react","react-jss","redux","yeoman"],"created_at":"2025-01-25T23:57:18.810Z","updated_at":"2025-06-30T11:03:01.622Z","avatar_url":"https://github.com/rob2d.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Greedux\nA modular, clean and scalable modern workflow template for React/Redux development\n\n![\"Greedux!\"](./greedux_logo.png)\n\n\n## Requirements ##\n* NodeJS : 6.x.x - Latest Stable Version\n* NPM : 3.x or higher (Preferably 5.x)\n\n## Features ##\n\n- Live reloading\n- Easy and declarative folder structure \n- Easily modifiable build code written in gulp; no magical configuration (!)\n- Modular React/Redux architecture which lend themselves well to unit testing\n- Includes simple JSS (via `react-jss`) for optimal/readable React styling\n- Easy \u0026 declarative multi-language support in your app out of the box\n- Minimal deployable Express server which supports easy switching between HTTP/HTTPS\n- Redux and Redux-Router\n- Flags for giving OS notices when builds are successful or fail\n\n\n## Installation ##\n\n1) Create a new folder for your new React/Redux project and navigate to that in your terminal/command line. \n2) Install Gulp Client, Yeoman and the generator by running: `npm install -g gulp-cli yo generator-greedux`\n3) Run `yo greedux`, which should install all build and server dependencies to get started on your new project!\n\n## Deployment ##\n\n### Packaging the app ###\nsimply run `gulp build` , and your server and assets are ready to go.\n\n#### Optional Flags ####\n- **success_notice**  : Display an OS-level success notice\n- **error_sound** : Whether to play an OS error sound when compile error happens\n- **build_js_debug** : Create a production level build, but do not strip debug messages from console.\n- **export_standalone** : Automatically generate a build folder corresponding to the time you created your package via a builds/[current_date] folder.\n\n#### Running the Node/Express Server ####\n\nNote: You must first build the app by calling `gulp build`.\n\nRun `node app` in your root folder after installing; it will list clearly \nhow to specify the proper flags for SSL if needed on your server when\nbooting up as well as which server (default port is `3002`).\n\nOr to simply build and run the app, run `npm start`.\n\n## Developing\n\n#### With Live-Reload Server ###\n\nIn CMD, type `gulp` to begin a live reload server at `localhost:8080`. \nCurrently, hot reloading only detects JS changes so server must be reset for other static resource changes.\n\n#### Typical Node/Express Development Server ###\n\nIf you would like to run without a hot reload server in dev mode, static changes can be detected when refreshing\nwithout re-running the dev server . simply run `gulp dev` and then in another console `node app --dev` \n(port can be specified as param but default is `3002`).\n\n#### Optional Flags ###\n\n- **version_bump** : Bump patch version on successful builds (default false)\n- **success_notice**  : Display an OS-level success notice\n- **error_sound** : Whether to play an OS error sound when compile error happens\n- **build_js_debug** : Create a production level build, but do not strip debug messages from console.\n\n## Build Configuration ##\n\n#### Configuring Module Aliases ####\nModules can be aliased to use as if they were a root npm module by specifying\nthem within the `aliases.json` located in the `build-config` folder.\n\n#### Configuring Build Paths/Folder Structure ####\nConfigure the build structure of your app via `paths.json` located in \nthe `build-config` folder. This includes where the source files, distribution files\nand javascript can be found and built to. Defaults are already specified but can be\noverridden.\n\n## Roadmap ##\n\nFor information on the things which are currently being focused on, please visit the [ROADMAP.md](ROADMAP.md) file.\n\n## Contribution and Reporting Issues ##\nPR Requests and issues are always welcome! But before doing so, please be sure to briefly look over the guidelines at laid out [CONTRIBUTING.md](CONTRIBUTING.md).\n\nThanks!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frob2d%2Fgreedux","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frob2d%2Fgreedux","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frob2d%2Fgreedux/lists"}