From d3a40cc1717ddb296ad3d03b7852393d7dd8b874 Mon Sep 17 00:00:00 2001 From: maxxkim Date: Mon, 18 Dec 2023 13:49:05 +0000 Subject: [PATCH] Update README.md --- README.md | 80 +++++++++++++++++++++---------------------------------- 1 file changed, 30 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index c25cd7c5..b148f740 100644 --- a/README.md +++ b/README.md @@ -1,68 +1,48 @@ # eatvio_app -### Table of contents -- [System requirements](#system-requirements) -- [Figma design guidelines for better UI accuracy](#figma-design-guideline-for-better-accuracy) -- [Check the UI of the entire app](#app-navigations) -- [Application structure](#project-structure) -- [How to format your code?](#how-you-can-do-code-formatting) -- [How you can improve code readability?](#how-you-can-improve-the-readability-of-code) -- [Libraries and tools used](#libraries-and-tools-used) -- [Support](#support) +### Системные требования -### System requirements +- Flutter (Channel stable, 3.16.4, on Ubuntu 22.04.3 LTS 6.2.0-39-generic, locale en_US.UTF-8) +- Android Studio (version 2023.1) +- VS Code (version 1.85.0) +- Android SDK (version 34.0.0) - устанавливается из Android Studio (Tools->SDK Manager->Android Command Line Tools) +- Эмулятор (2 available) -Dart SDK Version 2.18.0 or greater. -Flutter SDK Version 3.3.0 or greater. - -### Figma design guidelines for better UI accuracy - -Read our guidelines to increase the accuracy of design-to-code conversion by optimizing Figma designs. -https://docs.dhiwise.com/docs/Designguidelines/intro - -### Check the UI of the entire app - -Check the UI of all the app screens from a single place by setting up the 'initialRoute'  to AppNavigation in the AppRoutes.dart file. - -### Application structure - -After successful build, your application structure should look like this: +### Структура приложения ``` . -├── android - It contains files required to run the application on an Android platform. -├── assets - It contains all images and fonts of your application. -├── ios - It contains files required to run the application on an iOS platform. -├── lib - Most important folder in the application, used to write most of the Dart code.. - ├── main.dart - Starting point of the application - ├── core - │ ├── app_export.dart - It contains commonly used file imports - │ ├── constants - It contains static constant class file - │ └── utils - It contains common files and utilities of the application - ├── presentation - It contains widgets of the screens - ├── routes - It contains all the routes of the application - └── theme - It contains app theme and decoration classes - └── widgets - It contains all custom widget classes +├── android - Папка для крмпиляции Android приложения +├── assets - Медиа и шрифты +├── ios - Папка для крмпиляции iOS приложения +├── lib - Основной код + ├── main.dart - Файл из которого компилируется приложение + ├── presentation - Виджеты экранов (верстка) + ├── routes - Роутер (пути до экранов) + └── theme - Темы и оформление + └── widgets - Кастомные виджеты ``` -### How to format your code? -- if your code is not formatted then run following command in your terminal to format code - ``` - dart format . - ``` +### Как запускать? -### How you can improve code readability? +Для запуска на эмуляторе в программе VS Code скомпилируйте и запустите файл main.dart (предварительно необходимо установить эмулятор в Android Studio) -Resolve the errors and warnings that are shown in the application. +Для тестирования на устройствах Android в корневой папке проекта выполните команду -### Libraries and tools used +flutter build apk -- BLoC - State management +после чего .apk файл скомпилируется в директории build/app/outputs/flutter-apk/app-release.apk + +Данный файл установит приложение на устройство с актуальной версией OS + +### Библиотеки и инструменты + +- BLoC - контроль состояний https://bloclibrary.dev -- cached_network_image - For storing internet image into cache +- cached_network_image - кеширование картинок из веба https://pub.dev/packages/cached_network_image -### Support +### Поддержка -If you have any problems or questions, go to our Discord channel, where we will help you as quickly as possible: https://discord.com/invite/rFMnCG5MZ7 +Telegram: @maxx_kim (https://t.me/maxx_kim)