Skip to content

Commit b046812

Browse files
committed
Add Forge license and README
1 parent 969bb0c commit b046812

6 files changed

Lines changed: 90 additions & 1 deletion

File tree

‎CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ All notable changes to Forge are documented in this file.
44

55
## [Unreleased]
66

7+
- Added MIT licensing, About copyright, and project README documentation.
8+
79
## [0.0.19]
810

911

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Magnus Opera SAS
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Forge
2+
3+
Forge is a focus-first desktop GitHub client for working through repositories, pull requests, issues, workflows, and review state from a dense three-pane workspace.
4+
5+
The app is built with Electron, React, TypeScript, and Vite. It stays local-only: GitHub API access is handled by the Electron main process, and the GitHub token is not exposed to the renderer.
6+
7+
## Features
8+
9+
- Repository navigation with search, favorites, and local monitoring.
10+
- Project focus views for pull requests, workflow runs, issues, and workflows.
11+
- Pull request details with title editing, labels, review actions, readiness, auto-merge, comments, markdown, and GitHub URL actions.
12+
- Workflow and job views for inspecting GitHub Actions state.
13+
- Keyboard-friendly navigation with persistent three-pane context.
14+
- Light, dark, and system themes with accent colors and optional glass sidebar appearance.
15+
16+
## Development
17+
18+
Install dependencies:
19+
20+
```sh
21+
npm install
22+
```
23+
24+
Run the Electron app in development:
25+
26+
```sh
27+
npm run dev
28+
```
29+
30+
Build the app:
31+
32+
```sh
33+
make build
34+
```
35+
36+
Run tests:
37+
38+
```sh
39+
make test
40+
```
41+
42+
Run the changelog gate:
43+
44+
```sh
45+
make verify-changelog
46+
```
47+
48+
Create an unsigned macOS arm64 package:
49+
50+
```sh
51+
make package-mac-arm64 version=X.Y.Z
52+
```
53+
54+
## License
55+
56+
Forge is released under the MIT License. See [LICENSE](LICENSE).

‎electron/main/main.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ interface CacheRecord<T> {
7474

7575
const __dirname = path.dirname(fileURLToPath(import.meta.url));
7676
const appDisplayName = "Forge";
77+
const appCopyright = "Copyright (c) 2026 Magnus Opera SAS";
7778
const legacyAppName = "github-focus";
7879
const isDev = !app.isPackaged;
7980
const devServerUrl = process.env.VITE_DEV_SERVER_URL ?? "http://127.0.0.1:5173";
@@ -149,6 +150,7 @@ function configureAppPresentation(): void {
149150
applicationName: appDisplayName,
150151
applicationVersion: app.getVersion(),
151152
version: app.getVersion(),
153+
copyright: appCopyright,
152154
iconPath
153155
});
154156

@@ -272,13 +274,19 @@ function showAboutWindow(): void {
272274
font-size: 18px;
273275
line-height: 1.3;
274276
}
277+
278+
.copyright {
279+
color: #5f6368;
280+
font-size: 13px;
281+
}
275282
</style>
276283
</head>
277284
<body>
278285
<main>
279286
<img src="${iconDataUrl}" alt="" />
280287
<h1>${appDisplayName}</h1>
281288
<p>Version ${version} (${version})</p>
289+
<p class="copyright">${appCopyright}</p>
282290
</main>
283291
</body>
284292
</html>`;

‎package-lock.json‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
"productName": "Forge",
44
"version": "0.1.0",
55
"private": true,
6-
"author": "Magnus Opera",
6+
"author": "Magnus Opera SAS",
7+
"license": "MIT",
78
"type": "module",
89
"description": "A focus-first desktop GitHub client.",
910
"main": "dist-electron/electron/main/main.js",

0 commit comments

Comments
 (0)