{"id":19852527,"url":"https://github.com/thesoftwarehouse/react-starter-boilerplate","last_synced_at":"2025-04-06T03:06:32.164Z","repository":{"id":38823387,"uuid":"341209218","full_name":"TheSoftwareHouse/react-starter-boilerplate","owner":"TheSoftwareHouse","description":"A highly scalable React SPA boilerplate focused on performance and best practices, written in TypeScript.","archived":false,"fork":false,"pushed_at":"2025-02-11T12:46:36.000Z","size":5727,"stargazers_count":70,"open_issues_count":10,"forks_count":23,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-30T02:04:31.272Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://tsh.io/","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/TheSoftwareHouse.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","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":"2021-02-22T13:27:03.000Z","updated_at":"2025-03-09T13:09:03.000Z","dependencies_parsed_at":"2024-04-29T14:44:50.778Z","dependency_job_id":"9c9efa5c-fe65-409b-b567-adddcc6585a7","html_url":"https://github.com/TheSoftwareHouse/react-starter-boilerplate","commit_stats":{"total_commits":418,"total_committers":34,"mean_commits":"12.294117647058824","dds":0.8492822966507176,"last_synced_commit":"96f7cccfbacc68991a9cc935c0c2120255e119d6"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheSoftwareHouse%2Freact-starter-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheSoftwareHouse%2Freact-starter-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheSoftwareHouse%2Freact-starter-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheSoftwareHouse%2Freact-starter-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheSoftwareHouse","download_url":"https://codeload.github.com/TheSoftwareHouse/react-starter-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247427006,"owners_count":20937201,"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":[],"created_at":"2024-11-12T14:03:18.069Z","updated_at":"2025-04-06T03:06:32.145Z","avatar_url":"https://github.com/TheSoftwareHouse.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n \u003cimg src=\".github/images/react-starter.svg\" alt=\"\" /\u003e\n\u003c/p\u003e\n\n# React Starter Boilerplate\n\nA highly scalable and focused on performance and best practices boilerplate code for TypeScript based React SPA applications.\n\nThis project was bootstrapped with [Vite](https://github.com/vitejs/vite) and modified by TSH team.\n\nStart your new React application in seconds!\n\n![GitHub stars](https://img.shields.io/github/stars/TheSoftwareHouse/react-starter-boilerplate?style=social)\n![GitHub watchers](https://img.shields.io/github/watchers/TheSoftwareHouse/react-starter-boilerplate?style=social)\n![GitHub followers](https://img.shields.io/github/followers/TheSoftwareHouse?style=social)\n\n![Discord](https://img.shields.io/discord/955763210420649995)\n![Version](https://img.shields.io/github/package-json/v/TheSoftwareHouse/react-starter-boilerplate)\n![GitHub License](https://img.shields.io/github/license/TheSoftwareHouse/react-starter-boilerplate)\n\n## Features\n\n### Quick scaffolding\n\nGenerate React code snippets from the CLI by using Plop micro-generator framework.\n\n### TypeScript\n\nThe best way to write modern frontend applications. Code is easier to understand. By using TypeScript it is more difficult to write invalid code as was the case in dynamically typed languages.\n\n### Static code analysis\n\nFocus on writing code, not formatting it! Code formatter and linter keeps the code clean which makes work and communication with other developers more effective!\n\n## How to bootstrap your React project\n\nTo start your new React project based on the `react-starter-boilerplate` you need to follow this steps:\n\n1. Clone this repository:\n\n```shell\ngit clone https://github.com/TheSoftwareHouse/react-starter-boilerplate.git\n```\n\n2. Change the name of project directory to the name of your project.\n**Also don't forget to change the name of your application in `package.json` file.**\n\n3. Restore git history of the project. To do that, run following commands:\n```shell\nsudo rm -r .git\ngit init\ngit remote add origin \u003cyour empty project repository\u003e\ngit remote -v\n```\n\n4. Replace this file with `PROJECT_README.md` and fill all the placeholders with data about your project:\n```shell\nmv PROJECT_README.md README.md\n```\n\n5. Add all files to git history and create initial commit:\n```shell\ngit add .\ngit commit -m 'Initial commit'\ngit push origin master\n```\n\n6. Copy the `.env.dist` file to `.env.local` and populate the environment variables with the values used in the local environment\n\n```shell\ncp .env.dist .env.local\n```\n\nNow, your project is bootstrapped successfully! 🎉\n\nYou can install dependencies and start developing your React application 🚀\n\n## Scripts\n\n```shell\nnpm run [command_name]\n```\n\n- `start` - Launches the app in development mode on [http://localhost:3000](http://localhost:3000)\n- `build` - Compiles and bundles the app for deployment*\n- `build:ci` - Build command optimized for CI/CD pipelines\n- `build:analyze` - Builds the app and opens the rollup-plugin-visualizer report in the browser\n- `typecheck` - Validate the code using TypeScript compiler\n- `preview` - Boot up a local static web server that serves application build. It's an easy way to check if the production build looks OK on your local machine\n- `test` - Run unit tests with vitest\n- `coverage` - Run unit tests with code coverage calculation\n- `lint` - Validate the code using ESLint and Prettier\n- `lint:fix` - Validate and fix the code using ESLint and Prettier\n- `plop` - Run CLI with commands for code generation\n- `translations` - Run [Babelsheet](https://github.com/TheSoftwareHouse/babelsheet2) tool for fetch the latest translations\n- `serve:cypress` - Run Cypress E2E tests panel\n- `version` - Build CHANGELOG file base on git commits history\n- `e2e:open` - Run E2E tests panel\n- `e2e:ci:firefox`: Run E2E tests on Firefox browser in CI pipelines\n- `e2e:ci:chrome`: Run E2E tests on Chrome browser in CI pipelines\n\n*See the section about [deployment](https://vitejs.dev/guide/static-deploy.html) for more information.\n\n## Table of Contents\n\n1. [Technology stack](/docs/01-technology-stack.md)\n2. [Application structure](/docs/02-application-structure.md)\n3. [React Query abstraction](/docs/03-react-query-abstraction.md)\n4. [Using plop commands](/docs/04-using-plop-commands.md)\n5. [E2E tests](/docs/05-e2e-tests.md)\n\n## How to Contribute\n\nAnyone and everyone is welcome to contribute. Start by checking out the list of [open issues](https://github.com/TheSoftwareHouse/react-starter-boilerplate/issues).\n\nHowever, if you decide to get involved, please take a moment to review the [guidelines](CONTRIBUTING.md).\n\n## License\n\nCopyright © 2021-present The Software House. This source code is licensed under the MIT license found in the\n[LICENSE](LICENSE.md) file.\n\n---\n\u003csup\u003e\nMade with ♥ by The Software House (\u003ca href=\"https://tsh.io\"\u003ewebsite\u003c/a\u003e, \u003ca href=\"https://tsh.io/blog\"\u003eblog\u003c/a\u003e)\nand \u003ca href=\"https://github.com/TheSoftwareHouse/react-starter-boilerplate/graphs/contributors\"\u003econtributors\u003c/a\u003e.\n\u003c/sup\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthesoftwarehouse%2Freact-starter-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthesoftwarehouse%2Freact-starter-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthesoftwarehouse%2Freact-starter-boilerplate/lists"}