Skip to content

Latest commit

 

History

History
118 lines (86 loc) · 3.72 KB

README.md

File metadata and controls

118 lines (86 loc) · 3.72 KB
Raw

Zap App

Zap is an AI-powered note-taking application that allows users to quickly record and analyze their thoughts, ideas, and tasks using text, voice, and photos. With advanced AI capabilities for smart summarization, image analysis, and audio transcription, Zap provides a more convenient and efficient recording experience.

TestFlight Link

https://testflight.apple.com/join/pjpeTkap

Demo

Ultramarine iPhone 16 Mockup iPhone 15 Pro Hand Mockup
CleanShot.2024-11-02.at.12.10.23.-.01.mp4

Features

  • Multi-modal input: Text, voice, and photo capture
  • AI-powered note summarization
  • Image analysis and description
  • Smart audio transcription
  • Note management (add, edit, delete, mark as complete)
  • Customizable appearance settings

Planned Features

  • Enhanced AI-powered categorization and tagging
  • Cross-platform synchronization
  • Multi-platform support

Project Structure

The project is organized into several key components:

  • ContentView.swift: The main entry point of the app
  • HomeView.swift: The primary view for displaying and managing notes
  • NoteRowView.swift: Individual note display component
  • AudioNoteView.swift: Audio recording and transcription functionality
  • ImagePicker.swift: Photo and video capture functionality
  • FullScreenMediaView.swift: Full-screen media viewing
  • AppearanceSettingsView.swift: Customizable appearance settings
  • AIManager.swift: Handles AI-related operations (summarization, image analysis, transcription)
  • Backend code: GitHub Repo

For AI or Contributors

This project has recently integrated AI capabilities. The main focus areas for future development include:

  1. Enhancing AI-powered categorization and tagging of notes
  2. Developing cross-platform synchronization capabilities
  3. Expanding to support multiple platforms (iOS, macOS, web)
  4. Improving AI model accuracy and performance

When contributing to this project, please follow the commit message guidelines provided below to maintain a clean and organized project history.

Commit Message Guidelines

To maintain a clean and organized project history, please follow these commit message guidelines:

Format:

type: subject

General Rules:

  • Separate different types of changes into different commits.
  • Keep the subject concise, no more than 50 characters.
  • Use English consistently.
  • For detailed explanations, add a blank line after the subject.

Commit Types:

  • feat: New feature
  • fix: Bug fix
  • refactor: Code refactoring
  • docs: Documentation changes
  • style: Code style changes (not CSS)
  • test: Test case modifications
  • chore: Other changes (e.g., build process, dependencies)

Examples:

feat: add user login functionality
fix: resolve slow loading issue on homepage
docs: update project description in README.md
style: standardize code indentation
refactor: restructure data processing module
test: add unit tests for user registration
chore: update dependency versions in package.json

Detailed Example:

feat: add user login functionality

- Implement JWT authentication
- Create login form component
- Add login state management

Related issue: #123

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Contact

Contact Zigao Wang at [email protected], or open an issue: https://github.com/ZapNotesApp/Zap/issues