Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
* @sohaibilyas

/.github/ @sohaibilyas
/LICENSE @sohaibilyas
/NOTICE @sohaibilyas
/LICENSING.md @sohaibilyas
/TRADEMARKS.md @sohaibilyas
19 changes: 19 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
version: 2
updates:
- package-ecosystem: npm
directory: /
schedule:
interval: weekly
open-pull-requests-limit: 5

- package-ecosystem: cargo
directory: /src-tauri
schedule:
interval: weekly
open-pull-requests-limit: 5

- package-ecosystem: github-actions
directory: /
schedule:
interval: weekly
open-pull-requests-limit: 5
49 changes: 49 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: CI

on:
pull_request:
push:
branches:
- main

permissions:
contents: read

concurrency:
group: ci-${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
test:
runs-on: macos-15
timeout-minutes: 30

steps:
- name: Check out source
uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6
with:
persist-credentials: false

- name: Set up Node.js
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
with:
node-version: 22
cache: npm

- name: Install frontend dependencies
run: npm ci

- name: Build frontend
run: npm run build

- name: Check Rust formatting
run: cargo fmt --manifest-path src-tauri/Cargo.toml --all -- --check

- name: Check Rust library
run: cargo check --manifest-path src-tauri/Cargo.toml --lib --locked

- name: Test Rust library
run: cargo test --manifest-path src-tauri/Cargo.toml --lib --locked

- name: Test native Swift package
run: swift test --package-path src-tauri/native
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ src-tauri/native/.build
*.cer
*.certSigningRequest
*.key
*.mobileprovision
*.provisionprofile
*.keychain-db
*.dmg
*.pkg
*.app.tar.gz
*.sig
/latest.json
.env
.env.*
!.env.example
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Contributing to Macnu

Bug reports and feature requests are welcome through GitHub Issues.

## Pull requests and patches

Macnu does not accept pull requests, patches, code snippets, documentation,
translations, designs, or other copyrightable contributions yet.

The project needs a contributor agreement before it can accept outside work
while retaining the rights required for separate commercial licensing.
Unsolicited contributions will be closed without merging. The public source
license still permits forks and modifications for purposes covered by the
`LICENSE` file.

## Issues

Bug reports should include the Macnu version, macOS version, reproduction
steps, and expected result. Feature requests should describe the use case.
Do not include patches or implementation code in an issue. Report security
problems through [SECURITY.md](SECURITY.md).
131 changes: 131 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
# PolyForm Noncommercial License 1.0.0

<https://polyformproject.org/licenses/noncommercial/1.0.0>

## Acceptance

In order to get any license under these terms, you must agree
to them as both strict obligations and conditions to all
your licenses.

## Copyright License

The licensor grants you a copyright license for the
software to do everything you might do with the software
that would otherwise infringe the licensor's copyright
in it for any permitted purpose. However, you may
only distribute the software according to [Distribution
License](#distribution-license) and make changes or new works
based on the software according to [Changes and New Works
License](#changes-and-new-works-license).

## Distribution License

The licensor grants you an additional copyright license
to distribute copies of the software. Your license
to distribute covers distributing the software with
changes and new works permitted by [Changes and New Works
License](#changes-and-new-works-license).

## Notices

You must ensure that anyone who gets a copy of any part of
the software from you also gets a copy of these terms or the
URL for them above, as well as copies of any plain-text lines
beginning with `Required Notice:` that the licensor provided
with the software. For example:

> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)

## Changes and New Works License

The licensor grants you an additional copyright license to
make changes and new works based on the software for any
permitted purpose.

## Patent License

The licensor grants you a patent license for the software that
covers patent claims the licensor can license, or becomes able
to license, that you would infringe by using the software.

## Noncommercial Purposes

Any noncommercial purpose is a permitted purpose.

## Personal Uses

Personal use for research, experiment, and testing for
the benefit of public knowledge, personal study, private
entertainment, hobby projects, amateur pursuits, or religious
observance, without any anticipated commercial application,
is use for a permitted purpose.

## Noncommercial Organizations

Use by any charitable organization, educational institution,
public research organization, public safety or health
organization, environmental protection organization,
or government institution is use for a permitted purpose
regardless of the source of funding or obligations resulting
from the funding.

## Fair Use

You may have "fair use" rights for the software under the
law. These terms do not limit them.

## No Other Rights

These terms do not allow you to sublicense or transfer any of
your licenses to anyone else, or prevent the licensor from
granting licenses to anyone else. These terms do not imply
any other licenses.

## Patent Defense

If you make any written claim that the software infringes or
contributes to infringement of any patent, your patent license
for the software granted under these terms ends immediately. If
your company makes such a claim, your patent license ends
immediately for work on behalf of your company.

## Violations

The first time you are notified in writing that you have
violated any of these terms, or done anything with the software
not covered by your licenses, your licenses can nonetheless
continue if you come into full compliance with these terms,
and take practical steps to correct past violations, within
32 days of receiving notice. Otherwise, all your licenses
end immediately.

## No Liability

***As far as the law allows, the software comes as is, without
any warranty or condition, and the licensor will not be liable
to you for any damages arising out of these terms or the use
or nature of the software, under any kind of legal claim.***

## Definitions

The **licensor** is the individual or entity offering these
terms, and the **software** is the software the licensor makes
available under these terms.

**You** refers to the individual or entity agreeing to these
terms.

**Your company** is any legal entity, sole proprietorship,
or other kind of organization that you work for, plus all
organizations that have control over, are under the control of,
or are under common control with that organization. **Control**
means ownership of substantially all the assets of an entity,
or the power to direct its management and policies by vote,
contract, or otherwise. Control can be direct or indirect.

**Your licenses** are all the licenses granted to you for the
software under these terms.

**Use** means anything you do with the software requiring one
of your licenses.
37 changes: 37 additions & 0 deletions LICENSING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Licensing Macnu

Macnu is source-available under the
[PolyForm Noncommercial License 1.0.0](LICENSE). This page is a plain-language
summary. The `LICENSE` file controls if the two differ.

Except where a file or third-party notice says otherwise, the Macnu-owned
contents of this repository use that license. Third-party components and
generated material keep their own terms.

## Noncommercial use

The license permits use, copying, modification, and distribution for
noncommercial purposes, subject to its full terms. This includes the personal
uses and noncommercial organizations listed in the license.

Anyone who distributes Macnu or a modified version must include the license
terms or their canonical URL and preserve every `Required Notice` supplied
with Macnu, including [NOTICE](NOTICE).

## Commercial use

This repository does not grant commercial-use rights. Using Macnu for a
commercial purpose requires a separate written license from Sohaib Ilyas.
Commercial licensing is not available yet. This page will be updated before
commercial licenses are offered.

## Official builds

Source access does not make a build an official Macnu release. Official builds
will originate from the project's GitHub Releases page and may be signed with
Sohaib Ilyas's Apple Developer ID and submitted to Apple for notarization.

The source license does not grant access to Apple signing credentials,
notarization credentials, update-signing private keys, or permission to present
a build as an official Macnu release. Forks and self-built versions must use
their own signing identity and follow [TRADEMARKS.md](TRADEMARKS.md).
1 change: 1 addition & 0 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Required Notice: Copyright 2026 Sohaib Ilyas.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,14 @@ npm run build:app
The packaged app is written to `src-tauri/target/release/bundle/macos`.
Production releases must instead use a Developer ID signature and Apple
notarization.

## License

Macnu is source-available under the
[PolyForm Noncommercial License 1.0.0](LICENSE). You may use, study, modify,
and share it for purposes permitted by that license. This is not an
OSI-approved open-source license because it does not permit commercial use.

Commercial use requires a separate written license from Sohaib Ilyas. See
[LICENSING.md](LICENSING.md). The [Macnu name and branding](TRADEMARKS.md),
Apple signing credentials, and update-signing private keys remain reserved.
20 changes: 20 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Security Policy

## Supported versions

Security reports are accepted for the latest Macnu release and the current
default branch. A fix may require users of older versions to upgrade.

## Reporting a vulnerability

Use [GitHub private vulnerability reporting](https://github.com/sohaibilyas/macnu/security/advisories/new).
Do not open a public issue for an undisclosed vulnerability.

Include the affected Macnu and macOS versions, the impact, reproduction steps,
and a proof of concept or relevant logs when available. Remove passwords,
private keys, personal information, and unrelated user data before submitting
a report.

Macnu does not currently offer a bug bounty or promise a response deadline.
Packaging problems limited to a third-party fork or build should be reported
to that build's maintainer.
14 changes: 14 additions & 0 deletions TRADEMARKS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Macnu Trademarks

The Macnu name, app icon, logo, and other project branding are not licensed
under the software license.

You may use the Macnu name to identify this project, link to the official
repository, or accurately describe another project as based on Macnu. Such use
must not imply endorsement or official status.

Public distributions of modified versions must use a distinct product name,
app icon, bundle identifier, and update channel. Do not present a fork,
self-built binary, or third-party package as an official Macnu release.

This policy does not limit uses permitted by applicable trademark law.
1 change: 1 addition & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
"name": "macnu",
"private": true,
"version": "0.1.0",
"license": "PolyForm-Noncommercial-1.0.0",
"author": "Sohaib Ilyas",
"repository": {
"type": "git",
"url": "git+https://github.com/sohaibilyas/macnu.git"
},
"bugs": {
"url": "https://github.com/sohaibilyas/macnu/issues"
},
"type": "module",
"scripts": {
"dev": "vite",
Expand Down
5 changes: 4 additions & 1 deletion src-tauri/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
name = "macnu"
version = "0.1.0"
description = "A fast, searchable launcher for crowded macOS menu bars"
authors = ["Macnu"]
authors = ["Sohaib Ilyas"]
edition = "2021"
license = "PolyForm-Noncommercial-1.0.0"
repository = "https://github.com/sohaibilyas/macnu"
publish = false

[lib]
name = "macnu_lib"
Expand Down