{"id":22267427,"url":"https://github.com/tejachundru/react-vite-starter","last_synced_at":"2025-04-15T00:22:49.969Z","repository":{"id":267588443,"uuid":"867993845","full_name":"tejachundru/react-vite-starter","owner":"tejachundru","description":"React starter powered with vite + redux toolkit + rtkquery + react router + shadcn ui and many more","archived":false,"fork":false,"pushed_at":"2025-02-06T08:08:42.000Z","size":412,"stargazers_count":9,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-06T09:23:37.311Z","etag":null,"topics":["commitlint","eslint","react-boilerplate","react-testing-library","redux","redux-toolkit","rtk-query","shacnui","tailwind","vite","vite-template","vitest"],"latest_commit_sha":null,"homepage":"https://react-vite-starter-ten.vercel.app/","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/tejachundru.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":"2024-10-05T07:32:26.000Z","updated_at":"2025-02-06T08:08:45.000Z","dependencies_parsed_at":"2024-12-11T08:39:32.086Z","dependency_job_id":null,"html_url":"https://github.com/tejachundru/react-vite-starter","commit_stats":null,"previous_names":["tejachundru/react-vite-starter"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tejachundru%2Freact-vite-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tejachundru%2Freact-vite-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tejachundru%2Freact-vite-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tejachundru%2Freact-vite-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tejachundru","download_url":"https://codeload.github.com/tejachundru/react-vite-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240261494,"owners_count":19773474,"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":["commitlint","eslint","react-boilerplate","react-testing-library","redux","redux-toolkit","rtk-query","shacnui","tailwind","vite","vite-template","vitest"],"created_at":"2024-12-03T11:01:43.038Z","updated_at":"2025-04-15T00:22:49.961Z","avatar_url":"https://github.com/tejachundru.png","language":"TypeScript","funding_links":[],"categories":["Boilerplates / Templates","Boilerplates \u0026 Starters"],"sub_categories":[],"readme":"# React Vite Starter\n\nWith all batteries included in this project, you can start building React apps with Vite.\n\nThis project is a starter template using **Vite** for fast React development with TypeScript, TailwindCSS, and other modern tools for building, linting, formatting, and testing.\n\n## Get Started\n\n```sh\n# Clone the repository\ngit clone https://github.com/tejachundru/vite-starter\n\n# Navigate to the project directory\ncd vite-starter\n\n# Reset the git repository\nrm -rf .git\n\n# Install dependencies\npnpm install\n\n# Setup project\npnpm run bootstrap\n\n# Start development\npnpm run dev\n```\n\n## Overview\n\nBuilt with type safety, scalability, and developer experience in mind. A batteries included Vite + React template.\n\n- [**React**](https://react.dev) ⚛️ - A modern front-end JavaScript library for building user interfaces based on components\n- [**Vite**](https://vitejs.dev) ⚡ - Feature rich and highly optimized frontend tooling with TypeScript support out of the box\n- [**TypeScript**](https://www.typescriptlang.org) 🔷 - A typed superset of JavaScript designed with large scale applications in mind\n- [**Tailwind CSS**](https://tailwindcss.com) 🎨 - A utility-first CSS framework packed with classes to build any web design imaginable\n- [**ShadCN/ui**](https://ui.shadcn.com/) 🧩 - A UI library with a focus on simplicity and customization\n- [**ReactRouter**](https://reactrouter.com) 🧭 - A lightweight, fully-featured routing library for React\n- [**RTK Query**](https://redux-toolkit.js.org/) 🔄 - A toolkit for building RTK Query based applications\n- [**Zod**](https://zod.dev) 🛡️ - TypeScript-first schema validation with static type inference\n- [**Vitest**](https://vitest.dev) ⚡ - A blazing fast unit test framework powered by Vite\n- [**React Testing Library**](https://testing-library.com) 🧪 - A very light-weight, best practice first, solution for testing React components\n- [**Playwright**](https://playwright.dev) 🎭 - Enables reliable end-to-end testing for modern web apps\n- [**pnpm**](https://pnpm.io) 📦 - A strict and efficient alternative to npm with up to 3x faster performance\n- [**ESLint**](https://eslint.org) 🧹 - Static code analysis to help find problems within a codebase\n- [**Prettier**](https://prettier.io) ✨ - An opinionated code formatter\n- [**Storybook**](https://storybook.js.org) 📚 - A frontend workshop for building UI components and pages in isolation\n- [**react-i18next**](https://react.i18next.com/) 🌐 - A powerful internationalization framework for React/React Native based on i18next\n- [**Docker**](https://www.docker.com) 🐳 - Containerization tool for deploying your vite-react-boilerplate app\n- [**Husky**](https://github.com/typicode/husky#readme) + [**Commitizen**](https://github.com/commitizen/cz-cli#readme) + [**Commitlint**](https://github.com/conventional-changelog/commitlint#readme) 🐶 - Git hooks and commit linting to ensure use of descriptive and practical commit messages\n- [**ts-reset**](https://github.com/total-typescript/ts-reset#readme) 🔧 - Improvements for TypeScripts built-in typings for use in applications\n\n## Available Scripts\n\nIn this project, the following scripts are available:\n\n| Script               | Description                                                                  |\n| -------------------- | ---------------------------------------------------------------------------- |\n| `bootstrap`          | Initializes the project with Husky and Playwright                            |\n| `format`             | Formats the code using Prettier                                              |\n| `lint`               | Lints the code with ESLint to ensure coding standards are followed           |\n| `lint:fix`           | Fixes linting issues automatically                                           |\n| `dev`                | Starts the development server using Vite                                     |\n| `storybook`          | Launches Storybook in development mode to view and test UI components        |\n| `storybook:build`    | Builds Storybook for production                                              |\n| `test`               | Runs unit and end-to-end tests                                               |\n| `test:unit`          | Runs only unit tests                                                         |\n| `test:unit:coverage` | Runs unit tests with coverage report                                         |\n| `test:e2e`           | Runs only end-to-end tests                                                   |\n| `test:e2e:report`    | Shows the Playwright test report                                             |\n| `build`              | Builds the project for production using Vite                                 |\n| `preview`            | Starts the preview server with Vite to view the production build locally     |\n| `commitlint`         | Lints commit messages to ensure they follow the defined conventions          |\n| `commitizen`         | Initializes Commitizen to assist with conventional commit message formatting |\n\n## Project Structure\n\n```\nreact-vite-starter/\n├── .storybook/          # Storybook configuration\n├── e2e/                 # End-to-end tests\n├── public/              # Static assets\n├── src/\n│   ├── assets/          # Images, fonts, etc.\n│   ├── components/      # Reusable UI components\n│   ├── hooks/           # Custom React hooks\n│   ├── lib/             # Utility functions\n│   ├── locales/         # i18n translations\n│   ├── pages/           # Page components\n│   ├── router/          # Routing configuration\n│   ├── services/        # API services\n│   ├── store/           # Redux store and slices\n│   ├── App.tsx          # Main App component\n│   └── main.tsx         # Entry point\n```\n\n## Docker Build\n\n### Development\n\n```sh\ndocker build -t my-app -f ./Dockerfile.dev .\n```\n\n### Production Image Build\n\nThis image is production-optimized using a multi-stage build for a minimal footprint with built-in nginx configuration to efficiently serve your application.\n\n```sh\ndocker build -t my-app -f ./Dockerfile .\n```\n\nTo run the Docker container:\n\n```sh\ndocker run -p 8080:80 my-app\n```\n\n## Environment Variables\n\nCreate a `.env` file in the root directory with the following variables:\n\n```\nVITE_API_URL=https://api.example.com\n```\n\n## Contributing\n\n1. Fork the repository\n2. Create your feature branch: `git checkout -b feature/my-feature`\n3. Commit your changes: `pnpm run commitizen`\n4. Push to the branch: `git push origin feature/my-feature`\n5. Submit a pull request\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Resources for development\n\nSome resources links that can helpful while development\n\n- [Shadcn FormBuilder](https://shadcn-form-build.vercel.app/) - Create forms with Shadcn, react-hook-form and zod within minutes.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftejachundru%2Freact-vite-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftejachundru%2Freact-vite-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftejachundru%2Freact-vite-starter/lists"}