{"id":22207678,"url":"https://github.com/vitorsalgado/react-web-starter","last_synced_at":"2025-07-27T08:32:57.770Z","repository":{"id":37185402,"uuid":"119984133","full_name":"vitorsalgado/react-web-starter","owner":"vitorsalgado","description":"React Starter Project ","archived":false,"fork":false,"pushed_at":"2024-04-11T02:41:08.000Z","size":95628,"stargazers_count":2,"open_issues_count":5,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-11T04:13:35.367Z","etag":null,"topics":["archetype","boilerplate","clean-architechture","frontend","javascript","playwright-demo","react","reactjs","scaffolding","template","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/create-react-ts-web-starter","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/vitorsalgado.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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}},"created_at":"2018-02-02T13:20:55.000Z","updated_at":"2024-04-15T03:33:20.970Z","dependencies_parsed_at":"2024-02-26T03:25:57.547Z","dependency_job_id":"3cee352c-cf73-4a25-962c-22c5cad9db3e","html_url":"https://github.com/vitorsalgado/react-web-starter","commit_stats":{"total_commits":525,"total_committers":6,"mean_commits":87.5,"dds":0.3904761904761904,"last_synced_commit":"132d8ea15211473619e82e680002750a770083a6"},"previous_names":[],"tags_count":10,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitorsalgado%2Freact-web-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitorsalgado%2Freact-web-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitorsalgado%2Freact-web-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitorsalgado%2Freact-web-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vitorsalgado","download_url":"https://codeload.github.com/vitorsalgado/react-web-starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227786833,"owners_count":17819776,"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":["archetype","boilerplate","clean-architechture","frontend","javascript","playwright-demo","react","reactjs","scaffolding","template","typescript"],"created_at":"2024-12-02T19:14:07.001Z","updated_at":"2024-12-02T19:14:08.068Z","avatar_url":"https://github.com/vitorsalgado.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eReact Web Starter\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"docs/assets/logo.png\" alt=\"Logo\" /\u003e\n    \u003cbr\u003e\n    \u003ci\u003eStarter Project for \u003cstrong\u003eReact\u003c/strong\u003e using \u003cstrong\u003eTypeScript\u003c/strong\u003e that allows customization of all components. Dedicated to my projects. Maybe it works for you as well :) \u003cbr\u003e\u003cstrong\u003enpm init react-ts-web-starter\u003c/strong\u003e\u003c/i\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  This project goal is to learn and explore modern frontend technologies and serve as a base for my personal projects since I prefer to control mostly libs involved (for some reason 🙄). \u003cbr/\u003e  \n  \u003cb\u003ecreate-react-app\u003c/b\u003e might be a better choice for most cases, but if you like the project, check below how to use it :)\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/create-react-ts-web-starter\"\u003e\u003cstrong\u003ewww.npmjs.com/package/create-react-ts-web-starter\u003c/strong\u003e\u003c/a\u003e\n  \u003cbr\u003e\n  \u003cbr\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/vitorsalgado/react-web-starter/actions/workflows/ci.yml\"\u003e\n    \u003cimg src=\"https://github.com/vitorsalgado/react-web-starter/actions/workflows/ci.yml/badge.svg\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://codecov.io/gh/vitorsalgado/react-web-starter\"\u003e\n    \u003cimg src=\"https://codecov.io/gh/vitorsalgado/react-web-starter/branch/master/graph/badge.svg?token=BB87R38Z87\"/\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://codeclimate.com/github/vitorsalgado/react-web-starter/maintainability\"\u003e\n    \u003cimg src=\"https://api.codeclimate.com/v1/badges/126ad2708eb60164e6de/maintainability\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/prettier/prettier\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat\"/\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/create-react-ts-web-starter\"\u003e\n    \u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/v/create-react-ts-web-starter\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Overview\n\nA new React project can be bootstrapped using this repository as a template using the following command:\n\n```\nnpm init react-ts-web-starter\n```\n\nWithout parameters, the project will be created on a folder **my-app** in the same directory where you executed the command.  \nAll parameters available:\n\n```\n--destination=\u003cFOLDER_DESTINATION\u003e Defaults to the current directory\n--app=\u003cAPP_NAME\u003e Defaults to my-app\n```\n\nThe final folder will be the parameter `destination` concatenated with the parameter `app`.\n\n## Getting Started\n\n### Dependencies\n\n**NPM** is the project package manager.  \nRun the following command to install dependencies and prepare the environment with Git hooks:\n\n```\nnpm i\n```\n\n### Running the Dev Server\n\n```\nnpm start\n```\n\n### Running With Docker Compose\n\n```\nmake up\n```\n\n### Building\n\n```\nnpm run build\n```\n\n### Serving Dist Content with Nginx\n\n```\nmake dist\n```\n\n## Configurations\n\n**WebPack** is the module bundler used here.  \nSome build configurations can be changed using **environment variables**. These variables can also be set using **DotEnv**. Just place a **.env** on project root dir and modify the\nvalues\nyou want.     \nCheck [this Joi schema](config/env.ts) to see all variables and their respective default and allowed values.\n\n## Test\n\n**Jest** and **Playwright** are the testing frameworks for this project.  \nCheck the [jest.config.ts](jest.config.ts) and [playwright.config.ts](playwright.config.ts) configuration files.\n\n## Linters and Code Style\n\nThe mix of tools used to ensure code and commit style and best practices:\n\n- ESLint\n- Prettier\n- Stylelint\n- Commitlint\n- Lint Staged\n- Husky\n\n## CI\n\n- **GitHub Actions** for continuous integration\n- **Codecov** for test coverage reports\n- **Codacy** and **CodeClimate** for code analysis\n\n## Additional Tools\n\nCheck the [Makefile](Makefile) for some useful commands.  \nExecute `make` to show the _help_.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitorsalgado%2Freact-web-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvitorsalgado%2Freact-web-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitorsalgado%2Freact-web-starter/lists"}