Project

General

Profile

Actions
Copy link

dev #943

open

Project Setup and Initial Configuration

Added by Ayat Rahman over 1 year ago. Updated over 1 year ago.

Status:
Complete
Priority:
High
Assignee:
Ayat Rahman
Target version:
November Sprint 2
Start date:
11/07/2024
Due date:
11/10/2024 (about 17 months late)
% Done:

100%

Estimated time:
7:00 h
Spent time:
7:00 h

Description

Objective

Establish the project foundation for the Compress PDF mobile app by researching best practices for project structure, organizing assets, setting up necessary pages, and implementing version control rules.

Tasks Completed:

  1. Researching Best Project Structure Practices

    • Studied different architectural patterns and frameworks suitable for mobile app development.
    • Identified Clean Architecture, MVC, and MVVM as the most effective approaches for a maintainable and scalable structure.
    • Selected Clean Architecture for this project to ensure clear separation of concerns and easy maintainability.

  2. Creating the Project Structure

    • Organized the project into appropriate directories:
      • pages for UI components
      • services for handling business logic
      • widgets for reusable UI elements
      • utils for constants and helper functions.
    • Ensured the structure would scale as new features are added.

  3. Collecting Assets and Adding Those as Constants

    • Gathered assets for the app, including images, icons, and logos.
    • Added constants for assets such as SVG icons and images in the constants.dart file to make asset management centralized and easier to maintain.

  4. Creating Empty Pages for the App

    • Set up the following pages with placeholder content:
      • Home, Settings, Files, Tools, Trash, Compression, etc.
    • Structured the pages to align with the app’s core features and user flow.

  5. Implemented Husky/Commitlint Rules

    • Integrated Husky for pre-commit hooks to ensure quality checks before commits.
    • Set up Commitlint to enforce consistent commit messages using the Conventional Commits convention.
    • Ensured that commit messages are clear, consistent, and adhere to the established guidelines.

Outcome:

The foundational setup for the Compress PDF mobile app is complete, with a robust project structure, asset organization, empty pages ready for implementation, and version control best practices in place. Ready to begin feature development.

This issue tracks the initial configuration and organization of the Compress PDF project. Would you like to make any edits or updates to the details?

Actions
Copy link

Also available in: Atom PDF