Giter Club home page Giter Club logo

bones-swiftui's Introduction

OS Language Framework

Important

๐Ÿšจ This current version of Bones is still in development. It is not yet ready for production use.

๐Ÿฆด Bones iOS

Design System libraries for iOS applications

๐ŸŒ Introduction

Bones Design System is the framework that helps our ecosystem design and develop consistent, high-quality experiences. It consists of rules, principles, and guidelines likes used to design.

To help developers avoid any design mistakes, we prefix all our design system elements with the bones keyword. We also prefer to scope any type into a bones namespace enum.

๐Ÿ“ฆ Installation

Swift Package Manager

  1. Append Bones to your package's dependency array

    dependencies: [
      .package(
        url: "https://github.com/phoenisis/bones-swiftui",
        .upToNextMajor(from: "0.0.0")
      ),
      // Any other dependencies...
    ],
  2. Subsequently, integrate Bones to any target's dependency array requiring it

  .target(
    name: "YourSwiftTarget",
    dependencies: [
      .product(
        name: "Bones", 
        package: "bones-swiftui"
      ),
      // Any other dependencies...
    ]
  ),

๐Ÿ“– Documentation

๐Ÿ’ช Contributing

To ensure consistent code quality and adherence to best practices, we've integrated tools to help automate the process. Please follow the steps below to set up your development environment

1๏ธโƒฃ Install Required Tools

  • SwiftLint This is a tool to enforce Swift style and conventions
brew install swiftlint
  • pre-commit This tool is used to manage and maintain pre-commit hooks
brew install pre-commit

2๏ธโƒฃ Set Up Pre-commit Hook

After installing the necessary tools, set up the pre-commit hook by running the following command

echo '#!/usr/bin/env bash
./Scripts/process.sh --fail-on-errors

failed=$?
exit $failed' > .git/hooks/pre-commit-test && chmod +x .git/hooks/pre-commit-test

This command creates a hook in your .git directory, which will be executed before each commit. If the script encounters any errors, the commit will be aborted

Note

Ensure you're in your project's root directory when setting up the pre-commit hook. If you encounter any issues or have questions, please consult the project's maintainer or review our troubleshooting guide.

bones-swiftui's People

Contributors

phoenisis avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.