Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/duckduckgo/BrowserServicesKit

hacktoberfest ios macos swift

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/duckduckgo/BrowserServicesKit
Owner: duckduckgo
License: apache-2.0
Created: 2021-04-22T21:04:33.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-10-29T08:51:15.000Z (about 2 months ago)
Last Synced: 2024-10-29T10:01:51.274Z (about 1 month ago)
Topics: hacktoberfest, ios, macos, swift
Language: Swift
Homepage:
Size: 18.8 MB
Stars: 49
Watchers: 30
Forks: 32
Open Issues: 14
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome - BrowserServicesKit - null (etc)
awesome - BrowserServicesKit - null (etc)

README

        # BrowserServicesKit

 

## We are hiring!

DuckDuckGo is growing fast and we continue to expand our fully distributed team. We embrace diverse perspectives, and seek out passionate, self-motivated people, committed to our shared vision of raising the standard of trust online. If you are a senior software engineer capable in either iOS or Android, visit our [careers](https://duckduckgo.com/hiring/#open) page to find out more about our openings!

## What is it?

`BrowserServicesKit` is a package that contains modules shared between DuckDuckGo projects.

## Building

The package uses submodules, which will need to be cloned in order for the project to build:

Run `git submodule update --init --recursive`

`BrowserServicesKit` can be built manually two ways:

1. Build the `BrowserServicesKit` scheme by opening the Swift package in Xcode

2. Run `swift build -c release` to build a release binary

## Testing

Run `swift test` on the project root folder. Please note that running the tests on Xcode will not work.

## Additional configuration

In projects utilizing the Swift Package Manager, it may not be possible to specify a custom file name when creating new Swift files within Xcode, resulting in the generation of placeholder names (i.e. "File.swift"). To resolve this issue: 

Run `scripts/setup-new-file-template.sh`

It will add a template named "Swift File For Package" to your Xcode templates, allowing for the specification of a custom file name when creating new Swift files.

### SwiftLint

We use [SwiftLint](https://github.com/realm/SwiftLint) for enforcing Swift style and conventions, so you'll need to [install it](https://github.com/realm/SwiftLint#installation).

## License

DuckDuckGo is distributed under the Apache 2.0 [license](https://github.com/duckduckgo/BrowserServicesKit/blob/main/LICENSE).