Git Product home page Git Product logo

netstack's Introduction

NetStack 🛰

Twitter: @cypher_poet

A concurrency-based networking stack for modern Swift projects. Use as-is — or as a starting point for your own utilities.

Features

  • ✅ Composable, async-enabled primitives for performing network operations with Data and transforming Codable types.
  • ✅ Utilities for URLRequest configuration.
  • ✅ Utilities for mocking URLRequest responses in tests.

Installation

NetStack ships with two library products: NetStack and NetStackTestUtils.

Xcode Projects

Select File -> Swift Packages -> Add Package Dependency and enter https://github.com/CypherPoet/NetStack.

Swift Package Manager Projects

You can add CypherPoetNetStack as a package dependency in your Package.swift file:

let package = Package(
    //...
    dependencies: [
        .package(
            name: "CypherPoetNetStack",
            url: "https://github.com/CypherPoet/NetStack",
            .exact("0.0.6")
        ),
    ],
    //...
)

From there, refer to the NetStack "product" delivered by the CypherPoetNetStack "package" inside of any of your project's target dependencies:

targets: [
    .target(
        name: "YourLibrary",
        dependencies: [
            .product(
                name: "NetStack",
                package: "CypherPoetNetStack"
            ),
        ],
        ...
    ),
    ...
]

Then simply import NetStack wherever you’d like to use it.

Usage

Projects Using NetStack

Contributing

Contributions to NetStack are most welcome. Check out some of the issue templates for more info.

💻 Developing

Requirements

  • Xcode 13.0+

📜 Creating & Building Documentation

Documentation is built with Xcode's DocC. See Apple's guidance on how to build, run, and create DocC content.

For now, the best way to view the docs is to open the project in Xcode and run the Build Documentation command. At some point in the future, I'm hoping to leverage the tooling the develops for generating/hosting DocC documentation. (Please feel free to let me know if you have any ideas or tooling recommendations around this 🙂).

🏷 License

NetStack is available under the MIT license. See the LICENSE file for more info.

netstack's People

Contributors

cypherpoet avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Forkers

edmamulyan

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.