{"id":16178820,"url":"https://github.com/jassix/react-boilerplate","last_synced_at":"2025-03-16T10:31:28.795Z","repository":{"id":232290560,"uuid":"783301581","full_name":"jassix/react-boilerplate","owner":"jassix","description":"🤖 Boilerplate code for react applications.","archived":false,"fork":false,"pushed_at":"2024-04-11T20:50:55.000Z","size":32,"stargazers_count":31,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-11T08:44:50.345Z","etag":null,"topics":["boilerplate","chichane","cypress","effector","farfetched","frontend","fsd","jest","react","react-testing-library","storybook","template","web"],"latest_commit_sha":null,"homepage":"","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/jassix.png","metadata":{"files":{"readme":"README.md","changelog":null,"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-04-07T14:12:29.000Z","updated_at":"2024-10-16T13:11:27.000Z","dependencies_parsed_at":"2024-04-11T17:57:34.877Z","dependency_job_id":"f5f7f7eb-00e6-4fda-8488-8794d87c2a81","html_url":"https://github.com/jassix/react-boilerplate","commit_stats":null,"previous_names":["jassix/react-boilerplate"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jassix%2Freact-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jassix%2Freact-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jassix%2Freact-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jassix%2Freact-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jassix","download_url":"https://codeload.github.com/jassix/react-boilerplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243810890,"owners_count":20351614,"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":["boilerplate","chichane","cypress","effector","farfetched","frontend","fsd","jest","react","react-testing-library","storybook","template","web"],"created_at":"2024-10-10T05:24:36.635Z","updated_at":"2025-03-16T10:31:28.309Z","avatar_url":"https://github.com/jassix.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![GitHub License](https://img.shields.io/github/license/jassix/react-boilerplate)\n![GitHub Repo stars](https://img.shields.io/github/stars/jassix/react-boilerplate)\n\n# React.js Boilerplate\n\nThis is a boilerplate/template project for building React.js applications, utilizing several modern technologies and libraries including Effector for state management, Farfetched for data fetching, Cypress for end-to-end testing, Bun as runtime, Vite for fast development environment, Storybook for component documentation and testing, react-testing-library and Jest for unit testing, and Emotion for styling.\n\n## Technologies Used\n\n- **Effector**: State management library for React applications.\n- **Farfetched**: Lightweight and composable data fetching library.\n- **Cypress**: End-to-end testing framework.\n- **Bun**: Fast JS runtime.\n- **Vite**: Fast, opinionated web dev build tool that serves your code via native ES Module imports during development.\n- **Storybook**: UI component explorer for frontend developers.\n- **React Testing Library** and **Jest**: For unit testing React components.\n- **Emotion**: A performant and flexible CSS-in-JS library.\n\n## Features\n\n- Effortless state management with Effector.\n- Simplified data fetching with Farfetched.\n- Comprehensive testing capabilities with Cypress, Jest, and React Testing Library.\n- Efficient styling using Emotion.\n- Rapid development setup with Vite.\n- Component documentation and testing facilitated by Storybook.\n\n## Getting Started\n\n### Prerequisites\n\nMake sure you have Bun installed on your machine.\n\n### Installation\n\n1. Clone the repository:\n\n```bash\ngit clone https://github.com/jassix/react-boilerplate.git\n```\n\n2. Navigate to the project directory:\n\n```bash\ncd react-boilerplate\n```\n\n3. Install dependencies:\n\n```bash\nbun install\n```\n\n### Development\n\nTo start the development server, run:\n\n```bash\nbun dev\n```\n\nThis will start the Vite development server.\n\n### Building\n\nTo build the project for production, run:\n\n```bash\nbun run build\n```\n\nThis will generate a production-ready build in the `dist` directory.\n\n### Testing\n\n#### Unit Testing\n\nTo run unit tests using Jest, execute:\n\n```bash\nbun run test\n```\n\n#### End-to-End Testing\n\nCypress is used for end-to-end testing. To run Cypress tests, use:\n\n```bash\nbun run test:e2e\n```\n\n### Storybook\n\nTo start Storybook and view your components in isolation, run:\n\n```bash\nbun storybook\n```\n\n## Folder Structure\n\n```\n/\n├── public/\n├── src/\n│   ├── app/\n│   │   ├── providers/ - Applications providers\n│   │   ├── layouts/ - Different layouts for your pages\n│   │   ├── router/ - Router-Component, collect your routes in one place\n│   │   ├── styles/ - Global styles for your app\n│   │   ├── core.tsx - Root-Component, your providers and routing must will connected there\n│   │   └── index.tsx - Application entry-point\n│   ├── pages/ - Pages\n│   ├── widgets/ - Widgets\n│   ├── features/ - Features\n│   ├── entities/ - Entities\n│   └── shared/ - Shared\n│       ├── api/ - All requests to API\n│       ├── lib/ - Additional local \"libraries\"\n│       │    ├── media-query\n│       │    └── i18n\n│       ├── routing/ - Basement for routing, e.g. paths, or something else\n│       ├── config/ - General config for your app\n│       └── ui/ - UI-Kit, with atomic design\n│           ├── atom\n│           ├── molecules\n│           └── organisms\n└── package.json\n```\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n\n## Acknowledgements\n\n- [Effector](https://effector.dev/)\n- [Farfetched](https://farfetched.pages.dev/)\n- [Cypress](https://www.cypress.io/)\n- [Bun](https://bun.sh/)\n- [Vite](https://vitejs.dev/)\n- [Storybook](https://storybook.js.org/)\n- [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/)\n- [Jest](https://jestjs.io/)\n- [Emotion](https://emotion.sh/)\n\n---\n\nFeel free to contribute to this project and tailor it to your specific needs! If you encounter any issues or have suggestions for improvements, please open an issue or create a pull request. Happy coding! 🚀\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjassix%2Freact-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjassix%2Freact-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjassix%2Freact-boilerplate/lists"}