{"id":20109980,"url":"https://github.com/distributed-lab/react-mui-template","last_synced_at":"2026-06-12T07:33:53.762Z","repository":{"id":224893662,"uuid":"764061997","full_name":"distributed-lab/react-mui-template","owner":"distributed-lab","description":null,"archived":false,"fork":false,"pushed_at":"2024-06-23T17:13:23.000Z","size":2060,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-02T18:33:33.916Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"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/distributed-lab.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"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}},"created_at":"2024-02-27T12:14:04.000Z","updated_at":"2024-06-23T17:13:26.000Z","dependencies_parsed_at":"2024-04-08T11:57:07.873Z","dependency_job_id":null,"html_url":"https://github.com/distributed-lab/react-mui-template","commit_stats":null,"previous_names":["distributed-lab/react-mui-template"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/distributed-lab/react-mui-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/distributed-lab%2Freact-mui-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/distributed-lab%2Freact-mui-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/distributed-lab%2Freact-mui-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/distributed-lab%2Freact-mui-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/distributed-lab","download_url":"https://codeload.github.com/distributed-lab/react-mui-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/distributed-lab%2Freact-mui-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34234557,"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-12T02:00:06.859Z","response_time":109,"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":"2024-11-13T18:09:58.534Z","updated_at":"2026-06-12T07:33:53.746Z","avatar_url":"https://github.com/distributed-lab.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv style=\"text-align: center;\"\u003e\u003ch1\u003e\u003cb\u003eReact MUI template\u003c/b\u003e\u003c/h1\u003e\u003c/div\u003e\n\n### Pre-requisites\n\n#### Environment:\n\n- Node.JS 18 [**[Download Here]**]\n- Typescript 5.2 [**[Instructions to Download]**]\n\n| command                      | description                             |\n|------------------------------|-----------------------------------------|\n| `yarn install` / `yarn`      | install dependencies                    |\n| `yarn start`                 | start dev server                        |\n| `yarn build`                 | build project                           |\n| `yarn lint`                  | lint files (eslint + stylelint)         |\n| `yarn rsc [release-version]` | Lints release/release candidate version |\n|                              |                                         |\n\n### important:\n`.env-development` and `.env-production` is the custom solution for CI, which is used to build the app for different environments e.g. staging and production in github workflow files.\n\nBefore start development or manual deploy app with `dist` dir - make sure you have copied `.env-[environment]` file in to `.env.[environment]` file, where `[environment]` is the name of the environment, e.g. `.env-production` or `.env-staging` and fulfill it with your own values.\n\n```bash\ncp .env-development .env.development\n# or\ncp .env-production .env.production\n```\n\n### Build docker image with version\n```dockerfile\n docker build --no-cache --progress=plain --build-arg BUILD_VERSION=1.0.0-rc.0 -t react-template .\n```\n\n#### important\ndocker-compose config works with `.env` file only, so make sure you have it\n\n### Run container\n```\ndocker run -d -p 80:80 --name [container-name] [image-name]\n```\n\n## Prepare for deployment\n`.env-development` and `.end-production` is a files, which are used to run build in github workflow files, e.g. [here](.github/workflows/main.yml) at line 32\n\nIt sets the environment variables for the `vitejs` build, which are called in werf.yaml file `yarn start` command.\n\nAfter that, docker image could be used to deploy the app\n\nIf you want to build app locally, you can copy `.env-production` files and fulfill it with your own values, then run command `yarn build` or `.env-development` for `yarn start` command\n\n### Dealing with env variables\nEnv variables can be rewritten by [env.is] (./static/env.js) file in runtime. To do so, we need to provide same [env variables](.env.example) there in json format\n\n## Some additional features\n\n### JsonApi lib\n\n[@distributedlab/jac](https://distributed-lab.github.io/web-kit/modules/_distributedlab_jac.html)\n\n### Web3 provider wrapper lib\n\n[@distributedlab/w3p](https://distributed-lab.github.io/web-kit/modules/_distributedlab_w3p.html)\n\n### Utils, tools, helpers, ...etc\n\n[@distributedlab/tools](https://distributed-lab.github.io/web-kit/modules/_distributedlab_tools.html)\n\n## Contributing\n\nWe welcome contributions from the community! To contribute to this project, follow these steps:\n\n1. Fork the repository.\n1. Create a new branch with a descriptive name for your feature or bug fix.\n1. Make your changes and commit them.\n1. Push your changes to your branch on your GitHub fork.\n1. Create a pull request from your branch to the `main` branch of this repository.\n\nPlease ensure your pull request adheres to the following guidelines:\n- Add a clear pull request title;\n- Add a comprehensive pull request description that includes the motivation behind the changes, steps needed to test them, etc;\n- Update the [CHANGELOG.md] accordingly;\n- Keep the codebase clean and well-documented;\n- Make sure your code is properly tested;\n- Reference any related issues in your pull request;\n\nThe maintainers will review your pull request and may request changes or provide feedback before merging. We appreciate your contributions!\n\n\n## Changelog\n\nFor the changelog, see [CHANGELOG.md](./CHANGELOG.md).\n\n## License\n\nThis project is under the MIT License — see the [LICENSE](./LICENSE) file for details.\n\n[Download Here]: https://nodejs.org/en/download/\n[Instructions to Download]: https://www.typescriptlang.org/download\n[CHANGELOG.md]: ./CHANGELOG.md\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdistributed-lab%2Freact-mui-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdistributed-lab%2Freact-mui-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdistributed-lab%2Freact-mui-template/lists"}