feat: update readme decumentation

This commit is contained in:
Syaroful 2024-12-30 11:06:21 +07:00
parent f1f422d8f6
commit a7e5572912

View File

@ -35,11 +35,11 @@ This project uses several packages to support various functionalities. Below is
## Installation Guide
1. Clone the repository:
```bash
git clone https://github.com/username/smart-farming.git
git clone https://gitlab.com/profile-image/kedaireka/smartfarming/mobile-smartfarming.git
```
2. Navigate to the project directory:
2. Navigate to the flutter project directory:
```bash
cd smart-farming
cd agrilink_vocpro
```
3. Install dependencies:
```bash
@ -48,10 +48,22 @@ This project uses several packages to support various functionalities. Below is
if it does't work try:
```bash
flutter outdated
//follow with
// follow with
flutter pub upgrade --major-versions
```
or check your latest dart version make sure it compatible with this project
project tool version
```
• Flutter version 3.27.0-1.0.pre.685
• Upstream repository https://github.com/flutter/flutter.git
• Framework revision 227f6a04f7, 2024-12-03 13:21:59 +0100
• Engine revision f9d4f744e0
• Dart version 3.7.0 (build 3.7.0-207.0.dev)
• DevTools version 2.41.0
```
4. Run the project:
```bash
flutter run
@ -63,13 +75,13 @@ Berikan deskripsi singkat tentang struktur folder dan file penting di dalam proy
## Project Structure
- `lib/`: Contains the Flutter app source code.
- `core/`: Contains all constant vaalue and data needed for the project.
- `data/`: Conatains model and data response
- `core/`: Contains all constant value and data needed for the project.
- `data/`: Contains model and data response
- `domain/`: logic and service of the application
- `feature/`: Contains every feature in the app
- `provider/`
- `view`
- `widget`
- `provider/`: Contains a function to integrate with domain layer
- `view` : contains the main screen UI code
- `widget` : conatins the widget UI code
- `pubspec.yaml`: Project dependencies and configurations.