react-edge-kit

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-edge-kit - npm Package Compare versions

Comparing version

to
0.2.1

@@ -9,3 +9,3 @@ {

"homepage": "https://github.com/Quetan/react-edge-kit#readme",
"version": "0.2.0",
"version": "0.2.1",
"type": "module",

@@ -12,0 +12,0 @@ "author": "Quetan<quetan@vk.com>",

@@ -11,20 +11,20 @@ ![ReactEdge Kit logo](./public/logo.svg)

- [Author / Автор](#author--автор)
- [Contacts / Контакты](#contacts--контакты)
- [Features / Особенности](#features--особенности)
- [Getting Started / Начало работы](#getting-started--начало-работы)
- [Prerequisites / Предварительные требования](#prerequisites--предварительные-требования)
- [Detailed Steps / Подробные шаги](#detailed-steps--подробные-шаги)
- [File structure / Структура файлов](#file-structure--структура-файлов)
- [About Feature-Sliced Design / Про Feature-Sliced Design](#about-feature-sliced-design--про-feature-sliced-design)
- [Feature-Sliced Design scheme](#feature-sliced-design-scheme)
- [FAQ / Часто задаваемые вопросы](#faq--часто-задаваемые-вопросы)
- [Contribution / Сотрудничество](#contribution--сотрудничество)
- [License / Лицензия](#license--лицензия)
- [🗿 Author / Автор](#author--автор)
- [✉️ Contacts / Контакты](#contacts--контакты)
- [✨ Features / Особенности](#features--особенности)
- [🛠 Getting Started / Начало работы](#getting-started--начало-работы)
- [⚙️ Prerequisites / Предварительные требования](#prerequisites--предварительные-требования)
- [📄 Detailed Steps / Подробные шаги](#detailed-steps--подробные-шаги)
- [📂 File structure / Структура файлов](#file-structure--структура-файлов)
- [📦 About Feature-Sliced Design / Про FSD](#about-feature-sliced-design--про-feature-sliced-design)
- [📚 Feature-Sliced Design scheme](#feature-sliced-design-scheme)
- [⁉️ FAQ / Часто задаваемые вопросы](#faq--часто-задаваемые-вопросы)
- [✍️ Contribution / Сотрудничество](#contribution--сотрудничество)
- [⚖️ License / Лицензия](#license--лицензия)
## Author / _Автор_
## 🗿 Author / _Автор_
### Quetan (Korkin Kirill) / _Quetan (Коркин Кирилл)_
### Contacts / _Контакты_
### ✉️ Contacts / _Контакты_

@@ -35,3 +35,3 @@ - **Telegram**: [@quetan](https://t.me/KorkinK)

## Features / _Особенности_
## ✨ Features / _Особенности_

@@ -51,5 +51,5 @@ - **Development Environment (_Среда разработки_)**:

## Getting Started / _Начало работы_
## 🛠 Getting Started / _Начало работы_
### Prerequisites / _Предварительные требования_
### ⚙️ Prerequisites / _Предварительные требования_

@@ -60,3 +60,3 @@ Ensure you have Node.js and Yarn (or npm, pnpm, bun) installed on your machine.

### Detailed Steps / _Подробные шаги_
### 📄 Detailed Steps / _Подробные шаги_

@@ -67,4 +67,6 @@ 1. **Execute the installation script:**

```sh
npx react-edge-kit <your-project-name>
npx react-edge-kit
cd <your-project-name>
```

@@ -100,13 +102,13 @@

### File structure / _Структура файлов_
### 📂 File structure / _Структура файлов_
- **public/** _(public files directory)_
- **src/** _(source code directory)_
- [**app/**](./src/app/README.md)
- [**entities/**](./src/entities/README.md)
- [**features/**](./src/features/README.md)
- [**pages/**](./src/pages/README.md)
- [**routes/**](./src/routes/)
- [**shared/**](./src/shared/README.md)
- [**widgets/**](./src/widgets/README.md)
- **📁 public/** _(public files directory)_
- **📁 src/** _(source code directory)_
- [**📁 app/**](./src/app/README.md)
- [**📁 entities/**](./src/entities/README.md)
- [**📁 features/**](./src/features/README.md)
- [**📁 pages/**](./src/pages/README.md)
- [**📁 routes/**](./src/routes/)
- [**📁 shared/**](./src/shared/README.md)
- [**📁 widgets/**](./src/widgets/README.md)
- **routeTree.gen.ts** _(this file is auto-generated by TanStack Router)_

@@ -120,3 +122,3 @@ - [**.eslintrc.cjs**](./.eslintrc.cjs) _(ESLint configuration file)_

## About Feature-Sliced Design / _Про Feature-Sliced Design_
## 📦 About Feature-Sliced Design / _Про Feature-Sliced Design_

@@ -137,43 +139,43 @@ [![Feature-Sliced Design][shields-fsd-white]](https://feature-sliced.design/)

## FAQ / _Часто задаваемые вопросы_
## ⁉️ FAQ / _Часто задаваемые вопросы_
1. **How do I start a new project based on ReactEdge Kit?** / _Как начать новый проект на основе ReactEdge Kit?_
1. **❔ How do I start a new project based on ReactEdge Kit?** / _Как начать новый проект на основе ReactEdge Kit?_
Follow the instructions in the ["Getting Started"](#getting-started--начало-работы) section. Ensure you have Node.js and Yarn (or npm, pnpm, Bun) installed. Then clone the repository, install dependencies, and run the development server.
ℹ️ Follow the instructions in the ["Getting Started"](#getting-started--начало-работы) section. Ensure you have Node.js and NPM (or yarn, pnpm, Bun) installed.
> Следуйте инструкциям в разделе ["Начало работы"](#getting-started--начало-работы). Убедитесь, что у вас установлены Node.js и Yarn (или npm, pnpm, Bun). Затем клонируйте репозиторий, установите зависимости и запустите сервер разработки.
> Следуйте инструкциям в разделе ["Начало работы"](#getting-started--начало-работы). Убедитесь, что у вас установлены Node.js и NPM (или yarn, pnpm, Bun).
2. **When and why should I use FSD architecture?** / _Когда и зачем мне использовать архитектуру FSD?_
2. **❔ When and why should I use FSD architecture?** / _Когда и зачем мне использовать архитектуру FSD?_
You should read the ["Is it right for me?"](https://feature-sliced.design/docs/get-started/overview#is-it-right-for-me) article from the FSD documentation to understand if this architecture is suitable for your project.
ℹ️ You should read the ["Is it right for me?"](https://feature-sliced.design/docs/get-started/overview#is-it-right-for-me) article from the FSD documentation to understand if this architecture is suitable for your project.
> Рекомендуется ознакомиться со статьей ["Is it right for me?"](https://feature-sliced.design/docs/get-started/overview#is-it-right-for-me) в документации FSD, чтобы понять, подходит ли эта архитектура для вашего проекта.
3. **How do I add new routes to the application?** / _Как добавить новые маршруты в приложение?_
3. **❔ How do I add new routes to the application?** / _Как добавить новые маршруты в приложение?_
To add new routes, utilize `TanStack Router`. Detailed information can be found in the [TanStack Router documentation](https://tanstack.com/router/latest/docs/framework/react/guide/route-trees).
ℹ️ To add new routes, utilize `TanStack Router`. Detailed information can be found in the [TanStack Router documentation](https://tanstack.com/router/latest/docs/framework/react/guide/route-trees).
ReactEdge Kit uses a [file-based routing system](https://tanstack.com/router/latest/docs/framework/react/guide/file-based-routing) by default. You can switch to a [code-based routing system](https://tanstack.com/router/latest/docs/framework/react/guide/code-based-routing) if preferred.
4. **How can I customize the Shadcn/ui theme?** / _Как я могу настроить тему Shadcn/ui?_
4. **❔ How can I customize the Shadcn/ui theme?** / _Как я могу настроить тему Shadcn/ui?_
By default, ReactEdge Kit's primary color is orange (`#f97316`). You can interactively customize your theme on the official [Shadcn/ui website](https://ui.shadcn.com/themes).
ℹ️ Using the React Edge Kit installation wizard, you can select the primary color and font for your project. Additionally, you can interactively customize your theme on the [official Shadcn/ui website](https://ui.shadcn.com/themes).
> По умолчанию, основной цвет в ReactEdge Kit - оранжевый. Вы можете интерактивно настроить свою тему на официальном сайте [Shadcn/ui](https://ui.shadcn.com/themes).
> Используя мастер установки React Edge Kit, вы можете выбрать цвет темы и основной шрифт вашего проекта. Также вы можете интерактивно настроить свою тему на официальном сайте [Shadcn/ui](https://ui.shadcn.com/themes).
5. **How do I integrate third-party libraries and plugins?** / _Как интегрировать сторонние библиотеки и плагины?_
5. **❔ How do I integrate third-party libraries and plugins?** / _Как интегрировать сторонние библиотеки и плагины?_
Install the necessary libraries via Yarn or npm and import them into your project. Pay attention to Vite configuration and possible changes in configuration files (e.g., [`vite.config.ts`](./vite.config.ts)).
ℹ️ Install the necessary libraries via Yarn or npm and import them into your project. Pay attention to Vite configuration and possible changes in configuration files (e.g., [`vite.config.ts`](./vite.config.ts)).
> Установите необходимые библиотеки через Yarn или npm и импортируйте их в свой проект. Обратите внимание на конфигурацию Vite и возможные изменения в файлах конфигурации (например, `vite.config.ts`).
6. **What coding standards are used in ReactEdge Kit?** / _Какие стандарты используются в ReactEdge Kit?_
6. **❔ What coding standards are used in ReactEdge Kit?** / _Какие стандарты используются в ReactEdge Kit?_
The project uses `Prettier` and `ESLint` to ensure consistent code style and maintain quality. Configurations for these tools are located in the [.prettierrc](./.prettierrc) and [.eslintrc.cjs](./.eslintrc.cjs) files.
ℹ️ The project uses `Prettier` and `ESLint` to ensure consistent code style and maintain quality. Configurations for these tools are located in the [.prettierrc](./.prettierrc) and [.eslintrc.cjs](./.eslintrc.cjs) files.
> В проекте используются Prettier и ESLint для обеспечения единообразного стиля кода и поддержания качества. Конфигурации для этих инструментов находятся в файлах .prettierrc и .eslintrc.cjs.
7. **How do I enable PWA support?** / _Как включить поддержку PWA?_
7. **❔ How do I enable PWA support?** / _Как включить поддержку PWA?_
ReactEdge Kit already includes a [webmanifest](./public/favicon/site.webmanifest) for `PWA` support. Ensure your project is correctly configured and tested to work in PWA mode.
ℹ️ ReactEdge Kit already includes a [webmanifest](./public/favicon/site.webmanifest) for `PWA` support. Ensure your project is correctly configured and tested to work in PWA mode.

@@ -186,3 +188,3 @@ > ReactEdge Kit уже включает webmanifest для поддержки PWA. Убедитесь, что ваш проект правильно настроен и протестирован для работы в режиме PWA.

## Contribution / _Сотрудничество_
## ✍️ Contribution / _Сотрудничество_

@@ -193,4 +195,4 @@ Feel free to open issues or submit pull requests to help improve this project. Your contributions are welcome!

## License / _Лицензия_
## ⚖️ License / _Лицензия_
**[MIT](./LICENSE)**