Get started as a developer

cheat sheet for Flutter GrowERP

Getting started in an unknown territory is always a bit difficult. Here are some suggestions to make it easier!

1. Start with Documentation/Repository

• All parts in the same 'monorepo' repository

• DeepWiki AI overview: https://deepwiki.com/growerp/growerp

• GrowERPObs/3 Technical documentation - Detailed technical information about the architecture

• README.md - Installation instructions and overview

2. Understand the Architecture

• Frontend: Flutter-based applications (admin, hotel, freelance, support)

• Backend: Moqui framework with custom components

• Deployment: Docker containers orchestrated with docker-compose

3. Explore the Backend (Moqui)

1. Examine Service Definitions:

   • Check moqui/runtime/component/growerp/service/growerp/100/*.xml for backend services

2. Understand the REST API:

   • API documented at Swagger UI

3. Explore Data Model:

   • Data model in the mantle-udm component

4. Service-Oriented Architecture:

   • Functions are implemented as services in the runtime/component directory

4. Explore the Frontend (Flutter)

1. Understand Package Structure:

   • Packages in flutter/packages/

2. Examine Main Entry Points:

   • Check main.dart in each application package

3. Understand Menu Structure:

   • Defined in menu_options.dart

4. REST Client:

   • Check growerp_models/lib/src/rest_client.dart for API endpoints

5. Run the System Locally

1. Backend Setup:

cd moqui
./gradlew build
java -jar moqui.war load types=seed,seed-initial,install no-run-es
java -jar moqui.war no-run-es

1. Frontend Setup:

cd flutter

dart pub global activate melos 3.4.0
export PATH="$PATH":"$HOME/.pub-cache/bin"

melos bootstrap
melos l10n --no-select
melos build --no-select

cd packages/admin  # or hotel, freelance, etc.
flutter run

1. Docker Setup (Alternative):

   • Use docker-compose.yaml to run the system

6. Explore the Code Structure

1. BLoC Pattern:

   • The frontend uses the BLoC pattern for state management

2. Model Classes:

   • Examine the model classes in growerp_models to understand the data structures

3. Screen Templates:

   • Templates handle layout, navigation, and screen definitions

7. Test the System

1. Login to Backend:

   • Access http://localhost:8080/vapps with user: SystemSupport, password: moqui

2. Test Frontend Applications:

   • Run the admin, hotel, or other applications

8. Daily Startup Routine

1. Check System Status

2. Update Code

3. Review Recent Changes

4. Start Development Environment

5. Check API Documentation

6. Monitor Logs

7. Test Key Functionality