forked from eatvio/eatvio_app
Merge branch 'main' of ssh://10.55.5.123:222/maxxkim/eatvio_app
This commit is contained in:
82
README.md
82
README.md
@@ -1,68 +1,50 @@
|
|||||||
|
|
||||||
# eatvio_app
|
# 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.
|
├── android - Папка для крмпиляции Android приложения
|
||||||
├── assets - It contains all images and fonts of your application.
|
├── assets - Медиа и шрифты
|
||||||
├── ios - It contains files required to run the application on an iOS platform.
|
├── ios - Папка для крмпиляции iOS приложения
|
||||||
├── lib - Most important folder in the application, used to write most of the Dart code..
|
├── lib - Основной код
|
||||||
├── main.dart - Starting point of the application
|
├── main.dart - Файл из которого компилируется приложение
|
||||||
├── core
|
├── presentation - Виджеты экранов (верстка)
|
||||||
│ ├── app_export.dart - It contains commonly used file imports
|
├── routes - Роутер (пути до экранов)
|
||||||
│ ├── constants - It contains static constant class file
|
└── theme - Темы и оформление
|
||||||
│ └── utils - It contains common files and utilities of the application
|
└── widgets - Кастомные виджеты
|
||||||
├── presentation - It contains widgets of the screens
|
├── pubspec.yaml - Пакеты
|
||||||
├── routes - It contains all the routes of the application
|
|
||||||
└── theme - It contains app theme and decoration classes
|
|
||||||
└── widgets - It contains all custom widget classes
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### 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
|
https://bloclibrary.dev
|
||||||
- cached_network_image - For storing internet image into cache
|
- cached_network_image - кеширование картинок из веба
|
||||||
https://pub.dev/packages/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)
|
||||||
|
|||||||
Reference in New Issue
Block a user