1.1.3 Define Project Structure and Folder Organization

[amruthvvkp]

Description

This task establishes a clear and well-organized folder structure for our Teju's Studio mobile app project. This structure will facilitate efficient code management, improve collaboration, and maintain a clean codebase throughout development.

Tasks

Research and Design Folder Structure

• Consider common best practices for Flutter project organization.
• Research existing Flutter project structures or explore online resources for inspiration.
• Plan a folder structure that logically groups related code files, assets, and configuration settings.

Create Project Folders

• Within the root directory of your Flutter project, create designated folders based on your chosen structure.
• Typical folders might include:
  1. lib (or main): Contains the core Dart code for your app's functionalities.
  2. assets: Stores static assets like images, fonts, and icons.
  3. pubspec.yaml: The project's configuration file, specifying dependencies and plugins.
  4. You can further create subfolders within lib to categorize code by feature, screen, or functionality (e.g., screens, models, services, utils).

Document the Structure

Briefly document the chosen folder structure and its purpose. This can be a simple text file or a README within the project directory.

Acceptance Criteria

• A well-defined and documented folder structure is established for the project.
• The project's root directory and essential subfolders are created based on the chosen structure.
• Core Flutter files (e.g., main.dart) are placed within the appropriate folder.

Additional Notes

• There's no single "perfect" structure, so choose one that suits your project's complexity and your team's preferences.
• Maintain consistency throughout the project by adhering to the defined folder structure.
• Consider using tools like static code analysis or linters that can enforce coding conventions and folder organization best practices.

[amruthvvkp]

Useful references: https://towardsdatascience.com/create-an-ai-driven-movie-quiz-with-gemini-llm-python-fastapi-pydantic-rag-and-more-e15322be4f66 https://github.com/ravindrasinghh/Zero-to-Hero-Deploying-a-Full-Stack-AWS-Architecture-Using-Terraform/tree/master?tab=readme-ov-file https://aws.amazon.com/tutorials/design-a-database-for-a-mobile-app-with-dynamodb/ https://aws.amazon.com/blogs/architecture/field-notes-serverless-container-based-apis-with-amazon-ecs-and-amazon-api-gateway/

[amruthvvkp]

Alternatives in Python - https://reflex.dev/docs/authentication/authentication-overview/ https://docs.streamlit.io/