Skip to content

PetJournal/petjournal.ios

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

305 Commits
 
 
 
 
 
 
 
 

Repository files navigation

PetJournal

About App

PetJournal is an iOS app built on SwiftUI that allows users to manage information about their pets, including vaccinations, veterinary appointments and other relevant information.

🎯 Tech Requirements

  • Target deployment iOS 15.0
  • Xcode Version 14.2
  • Swift 5

🏛️ Project Architecture

  • This project uses MVVM as architecture

📚 Packages

  • Still under development.

Options for account creation and login.:

  • Create account: email/password
  • Login:
johndoe@email.com 
Teste@123

🗂️ Project organization

Commons Folder

This folder contains subfolders related to project helpers: Custom Classes, Extensions, Project Helpers.

Commons 
└───Enums
└───Extensions
└───Utils 
└───Services
└───UIComponents
└───Utils

Enums

This folder contains enumerations that will support application development. Not related to the application itself, they are generally generic.

Extensions

This folder contains all the extensions. Default is: Type+Extensions. Example: Extension+View / Extension+Color

Services

This folder contains files related to services used in the project.

Utils

This folder contains files related to Project Utilities and constants used in the project.

UIComponents

This folder contains visual components reused on different screens during the project, components used only on a screen, can be created with a subview of the screen.

*more items can be added during the project as needed

Features Folder

This folder contains application screen flow divided by main components, could contain subviews folders for its unique views.

Models Folder

This folder contains the app models.

Resources Folder

The Resources folder contains color, image, and font asset files. And project info.plist.

Sources Folder

This folder contains application startup controller, contains user session control Session folder.

Sources:
└───AppStart
└───Session 

AppStart

Files related to the app's initialization.

Session

This folder contains files related to the user's session, login state, and user information keys.

💻 To Use (for test)

Use the command below to clone the repository, using the Mac terminal.

git clone https://github.com/PetJournal/petjournal.ios.git

Open the file petJournal.xcodeproj

folderPetjournal

When opening the file, select the iPhone version you want. Then select the button similar to Play.

play

  • ps1.: wait for the simulator to open
  • ps2.: Make sure Xcode Version 14.2 is installed.

🧠 Contribution

  • Marcylene Barreto / @Marbarret - start: not found ~ until: 05/2023
  • Daiane Gonçalves / @daigoncalves14 - start: not found ~ until: 05/2023
  • Giovanni Favorin / @giovannifavorin - start: 01/2025 ~ until: 05/2025
  • Rafael Seron / @rafaseron - start: 01/2025 ~ until: currently
  • Rafael Melo / @rafaelnmelo - start: 01/2025 ~ until: currently

Mentor

About

No description or website provided.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 7

Languages