Skip to content

A local Database on iOS devices for Shortcuts creators.

License

Notifications You must be signed in to change notification settings

nuit-dhiver/folk-s-db

Repository files navigation

Folk's DB

A datastore for iOS devices, designed to serve as an alternative to traditional text files and other data storage methods.

🌟 Features

  • Collections: Organize data into collections for easy management.
  • Document-like Key-Value Stores: Store key-value records with unique IDs, enabling nested key-value stores within records.
  • GUI Access: Easily manage your data through an intuitive graphical user interface.
  • Shortcuts Integration: Access and manipulate stored data via Shortcuts intents for automation and advanced workflows.

🚀 Getting Started

Download on the App Store

Download on the App Store

Installation from source

  1. Clone the repository:
    git clone https://github.com/nuit-dhiver/folk-s-db
    
  2. Open the project in Xcode and build the app to your iOS device.

Usage

  1. Use the GUI to create, view, and manage your collections and records.
  2. Integrate the datastore with the Shortcuts app by using the provided intents, allowing quick access and automation of data management tasks.

🛠 Contribution Guidelines

We welcome all contributions, including feature suggestions, bug reports, and pull requests. To ensure a smooth collaboration, please follow these guidelines:

Submitting Issues or Suggestions

  • Clearly describe the issue or suggestion, including steps to reproduce or use cases if applicable.
  • Include relevant details like screenshots, logs, or environment information.

Creating Pull Requests

  • Ensure your pull request is clear and self-explanatory.
  • Follow the original coding standards and maintain code consistency.
  • Provide a concise description of the changes introduced and their purpose.

Example Workflow

  1. Fork the repository.
  2. Create a feature branch:

git checkout -b feature/your-feature-name

  1. Make changes and commit them:

git commit -m "Add feature description like: feat(name): short description"

  1. Push the branch and create a pull request.

📄 License

This project is licensed under the MIT License. You are free to use, modify, and distribute the code in this repository, provided that proper attribution is given.

❤️ Acknowledgments

Thank you for considering contributing to this project! Your feedback and support help make this datastore more powerful and user-friendly.

For any questions or inquiries, feel free to reach out via the Issues tab. Let’s build something amazing together!