{"id":15789948,"url":"https://github.com/nonblocking/mashroom-portal-quickstart","last_synced_at":"2025-03-14T13:30:35.945Z","repository":{"id":40579002,"uuid":"197347966","full_name":"nonblocking/mashroom-portal-quickstart","owner":"nonblocking","description":"Quickstart template for the Mashroom Server Portal, an Integration Platform for Microfrontends","archived":false,"fork":false,"pushed_at":"2024-07-08T09:09:17.000Z","size":5176,"stargazers_count":3,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-10-05T22:04:13.756Z","etag":null,"topics":["microfrontends"],"latest_commit_sha":null,"homepage":"https://www.mashroom-server.com","language":"TypeScript","has_issues":false,"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/nonblocking.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":"2019-07-17T08:27:13.000Z","updated_at":"2024-07-08T09:09:20.000Z","dependencies_parsed_at":"2024-01-22T09:24:27.258Z","dependency_job_id":"d8dba411-1285-460b-adb3-a12216aaaf81","html_url":"https://github.com/nonblocking/mashroom-portal-quickstart","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nonblocking%2Fmashroom-portal-quickstart","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nonblocking%2Fmashroom-portal-quickstart/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nonblocking%2Fmashroom-portal-quickstart/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nonblocking%2Fmashroom-portal-quickstart/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nonblocking","download_url":"https://codeload.github.com/nonblocking/mashroom-portal-quickstart/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243584040,"owners_count":20314685,"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":["microfrontends"],"created_at":"2024-10-04T22:04:18.093Z","updated_at":"2025-03-14T13:30:35.574Z","avatar_url":"https://github.com/nonblocking.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Mashroom Portal Quickstart\n\nQuickstart template for the [Mashroom Server](https://www.mashroom-server.com) Portal, an **Integration Platform for Microfrontends**.\n\nThis template demonstrates how to integrate a standalone React app into the Portal.\n\n## Prerequisites\n\n* Node.js \u003e= 18\n\n## Start the server\n\n* npm install\n* npm start\n\nOpen [http://localhost:5050](http://localhost:5050) in your browser.\n\nAvailable users:\n\n* john/john\n* admin/admin\n\nIf you start the server without NODE_ENV set it will be in development mode and automatically detect changes in the\nplugin-packages folder and hot reload plugins.\n\nSo, if you place the *Example React App* on a page and change its code it will be reloaded automatically.\n\n### Docker\n\nTo run the server within a docker container:\n\n    npm run docker:create-image\n    npm run docker:start\n\n### Production hints\n\nTo run the server in cluster mode you can start it with PM2 like so:\n\n    NODE_ENV=production pm2 start ./mashroom-starter -i max\n\n### Start the React app in development mode\n\n    npm run setup\n    cd plugin-packages/example-react-app\n    npm run dev\n\n## Configuration\n\nThere is a set of configuration files for development and production in the config folder.\n\n* Server config: *mashroom.json*\n* Log4js config: *log4js.json* or *log4js.js*\n* URL pattern based access control: *acl.json*\n* Users for simple security provider: *users.json*\n* The list of remote portal apps: *remote-portal-apps.json*\n\n## Storage\n\nThe Portal configuration will be stored in _data/storage_. Typically, you would put the json files there\nunder version control.\n\n## Plugins\n\nThis quickstart template consists of an example React Portal App, an example Theme, example Layouts and an example HTTP Proxy Interceptor.\nThe example Theme uses the *handlebars* template engine but you can use every available engine for *express*.\nHere an example of a type safe template written in React: https://github.com/nonblocking/mashroom/blob/master/packages/plugin-packages/mashroom-portal-demo-alternative-theme/src/backend/views/portal.tsx\n\n### Adding new Plugins\n\nAll modules added to the *plugin-packages* folders are scanned automatically.\n\nYou can also add plugins as *dependencies* in the root *package.json*.\nIn that case you have to add the path to the installed package (in node_modules) to the *pluginPackageFolders* in *mashroom.json*.\n\n## Development\n\nAll plugins can be developed standalone:\n\n* Example React App: Run *npm run dev* in the *example-react-app* folder\n* Example Theme: Run *npm run dev* in the *example-theme* folder and open http://localhost:6060\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnonblocking%2Fmashroom-portal-quickstart","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnonblocking%2Fmashroom-portal-quickstart","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnonblocking%2Fmashroom-portal-quickstart/lists"}