Skip to content

Commit 5b7b227

Browse files
committed
Readme file updated.
1 parent 4110dd5 commit 5b7b227

8 files changed

Lines changed: 44 additions & 27 deletions

File tree

.DS_Store

0 Bytes
Binary file not shown.

README.md

Lines changed: 44 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,15 @@
22

33
<div align="center">
44

5+
![DevAtlas Logo](./DevAtlasMac/Assets.xcassets/Icons/logo_brand.imageset/logo_brand-2.png)
6+
57
![Platform](https://img.shields.io/badge/platform-macOS%2014%2B-blue?logo=apple)
68
![Swift](https://img.shields.io/badge/Swift-5.9-orange?logo=swift)
79
![SwiftUI](https://img.shields.io/badge/SwiftUI-5-green)
810
![License](https://img.shields.io/badge/license-MIT-lightgrey)
911

10-
**The all-in-one developer workspace manager for macOS.**
11-
Scan, analyze, and navigate all your coding projects — without ever leaving your screen.
12+
**A native macOS command center for your entire local codebase.**
13+
Discover projects, inspect dependencies, analyze code health, track Git activity, keep project notes, and jump into work instantly.
1214

1315
[Features](#-features)[Getting Started](#-getting-started)[Tech Stack](#-tech-stack)[Contributing](#-contributing)
1416

@@ -18,16 +20,35 @@ Scan, analyze, and navigate all your coding projects — without ever leaving yo
1820

1921
## What is DevAtlas?
2022

21-
DevAtlas is a native macOS app built with SwiftUI that acts as a **mission control for developers**. It automatically discovers every project on your machine, detects the language and framework, checks your dependencies for updates, analyzes unused code, visualizes Git activity, and lets you jump into any editor with a single click — all from one beautiful, fast interface.
23+
DevAtlas is a native macOS app built with SwiftUI for developers who manage many local repositories at once. It scans your disks, identifies real projects from ecosystem-specific marker files, groups them by category and recency, surfaces dependency and code-health signals, and gives you one place to open, inspect, and continue work.
24+
25+
Instead of acting like another launcher, DevAtlas combines **workspace discovery**, **codebase intelligence**, **Git analytics**, **project notes**, and **quick actions** in a single desktop app.
26+
27+
## Why It Stands Out
28+
29+
- **Whole-machine project discovery**: scans your home folder and mounted volumes, with smart exclusions and custom ignore paths
30+
- **Polyglot project understanding**: recognizes Swift, Node.js, Flutter, Go, Rust, .NET, Python, Java, Docker, and more from real project markers
31+
- **Built-in dependency visibility**: parses manifests across multiple ecosystems and shows what each project depends on
32+
- **Actionable code insights**: includes unused code analysis, AI prompt workflows, line/file metrics, and Git activity trends
33+
- **Native developer workflow**: open projects in installed editors, Terminal, Finder, or Xcode without leaving the app
34+
- **Zero third-party runtime dependencies**: built entirely on Apple's native frameworks
35+
36+
## Screenshots
2237

23-
> Supports **20+ languages and frameworks** out of the box: Swift, Node.js, React, Next.js, Vue, Angular, Flutter, Go, Rust, Python, Java, PHP, Ruby, .NET, Docker, and more.
38+
| Screen | Description | Screenshot |
39+
|---|---|---|
40+
| Atlas | Main workspace view for discovering, filtering, and opening local projects. | <img src="./docs/app.png" alt="Atlas" width="500" /> |
41+
| Stats | Portfolio-level dashboard for code volume, project mix, and Git activity. | <img src="./docs/stats.png" alt="Stats" width="500" /> |
42+
| Notebook | Project-linked notes and todos with Markdown editing and organization tools. | <img src="./docs/notebook.png" alt="Notebook" width="500" /> |
43+
| AI Prompts | Curated engineering prompts for audits, refactoring, testing, and documentation workflows. | <img src="./docs/ai_prompts.png" alt="AI Prompts" width="500" /> |
44+
| Settings | App preferences for theme, language, scanning behavior, and personalization. | <img src="./docs/settings.png" alt="Settings" width="500" /> |
2445

2546
---
2647

2748
## ✨ Features
2849

2950
### 🔍 Intelligent Project Discovery
30-
DevAtlas scans all mounted disks on your Mac and automatically maps every coding project it finds. Projects are auto-categorized into **Web**, **Mobile**, **Desktop**, and **Cloud** and refreshed in the background as you work.
51+
DevAtlas's core strength is automatic project indexing across your machine. It scans mounted volumes and your home directory, resolves symlinks, removes duplicates, skips noisy folders, and turns raw directories into a structured project atlas.
3152

3253
- Full-disk recursive scan with smart exclusions (`node_modules`, `.git`, `build`, `dist`, etc.)
3354
- Auto-detects project type from marker files (`package.json`, `go.mod`, `pubspec.yaml`, `Dockerfile`, ...)
@@ -38,7 +59,7 @@ DevAtlas scans all mounted disks on your Mac and automatically maps every coding
3859
---
3960

4061
### 🤖 AI-Powered Code Analysis
41-
DevAtlas integrates **40+ AI-powered prompts** across 14 categories to help you improve your codebase. These prompts are designed to work with Claude, ChatGPT, or any LLM of your choice.
62+
DevAtlas ships with a dedicated prompt workspace for reviewing, refactoring, documenting, and stress-testing your code with external LLMs. The prompts are organized by engineering intent, so the app becomes a practical launchpad for deeper audits instead of a generic prompt list.
4263

4364
#### 📊 Code Quality
4465
| Prompt | Description |
@@ -51,8 +72,8 @@ DevAtlas integrates **40+ AI-powered prompts** across 14 categories to help you
5172

5273
#### ⚡ Performance
5374
| Prompt | Description |
54-
|-------- Bottleneck Analysis|-------------|
55-
| | Holistic performance audit with profiling suggestions |
75+
|--------|-------------|
76+
| Bottleneck Analysis | Holistic performance audit with profiling suggestions |
5677
| SwiftUI Render Optimization | View rendering efficiency improvements |
5778
| App Launch Optimization | Minimize time-to-interactive |
5879

@@ -65,8 +86,8 @@ DevAtlas integrates **40+ AI-powered prompts** across 14 categories to help you
6586

6687
#### 🧪 Testing
6788
| Prompt | Description |
68-
| Test Coverage Analysis | Identify|--------|-------------|
69-
untested code paths |
89+
|--------|-------------|
90+
| Test Coverage Analysis | Identify untested code paths |
7091
| Unit Test Audit | Test quality and reliability review |
7192
| Test Generator | Generate production-quality unit tests |
7293

@@ -89,7 +110,7 @@ DevAtlas integrates **40+ AI-powered prompts** across 14 categories to help you
89110
---
90111

91112
### 📦 Dependency Management & Version Checker
92-
See all your project's dependencies at a glance — and know instantly which ones are outdated.
113+
Dependency insight is built into the project detail flow. DevAtlas parses manifests directly from each repository and aggregates regular, development, and grouped project dependencies where applicable.
93114

94115
| Ecosystem | Manifest File |
95116
|---|---|
@@ -101,12 +122,8 @@ See all your project's dependencies at a glance — and know instantly which one
101122
| Swift (CocoaPods) | `Podfile` |
102123
| Swift (Carthage) | `Cartfile` |
103124
| .NET / C# | `.csproj`, `.sln` |
104-
| Java | `pom.xml`, `build.gradle` |
105-
| Python | `requirements.txt`, `pyproject.toml` |
106-
| PHP | `composer.json` |
107-
| Ruby | `Gemfile` |
108125

109-
DevAtlas fetches the **latest available version** of each package directly from the relevant registry (npm, pub.dev, crates.io, pkg.go.dev, etc.) using concurrent async requests — so you always know what needs updating.
126+
DevAtlas also checks package versions against upstream registries so outdated dependencies are visible without manually opening each manifest.
110127

111128
---
112129

@@ -123,7 +140,7 @@ Dead code is technical debt. DevAtlas scans your source files and highlights sym
123140
---
124141

125142
### 📊 Project Statistics & Git Insights
126-
A full picture of your codebase health — across every project, at once.
143+
The stats dashboard turns your local repos into a portfolio-level view. It combines code volume, project mix, and Git contribution history into one interface built with Swift Charts.
127144

128145
- Total file count and **lines of code** per project
129146
- **Git commit history**: commit count, activity graph, lines added/deleted
@@ -134,7 +151,7 @@ A full picture of your codebase health — across every project, at once.
134151
---
135152

136153
### 📝 Notebook
137-
A lightweight, project-linked note-taking system built right in.
154+
DevAtlas includes a local notebook layer so project context stays attached to the codebase instead of being scattered across separate apps.
138155

139156
- Notes and tasks tied to specific projects
140157
- Full **Markdown rendering**
@@ -145,12 +162,12 @@ A lightweight, project-linked note-taking system built right in.
145162
---
146163

147164
### ⚡ Quick Actions
148-
Stop hunting through Finder. Open any project directly in your preferred editor:
165+
Once a project is indexed, DevAtlas is also the fastest way back into it. Quick actions are designed for immediate context switching between discovery and execution.
149166

150-
- **VS Code**, **Xcode**, **Cursor**, **Zed**, and more
167+
- **VS Code**, **Xcode**, **Cursor**, **Windsurf**, **Antigravity**
151168
- Open in **Terminal** or **Finder** with one click
152169
- `⌘P` keyboard shortcut for instant project search
153-
- Run project scripts directly from the app
170+
- Run detected Node-based project scripts directly from the app
154171

155172
---
156173

@@ -162,10 +179,10 @@ Stop hunting through Finder. Open any project directly in your preferred editor:
162179

163180
---
164181

165-
### 🌍 Localization & Accessibility
166-
- 10+ languages: English, Turkish, German, French, Italian, Japanese, Korean, Simplified Chinese, and more
167-
- Full **Dark Mode** support
168-
- Native macOS look and feel with smooth animations
182+
### 🌍 Localization
183+
- Localized UI for English, Turkish, German, French, Italian, Japanese, Korean, and Simplified Chinese
184+
- Language switching built into settings
185+
- Native SwiftUI interface with macOS-first interaction patterns
169186

170187
---
171188

@@ -187,7 +204,7 @@ Zero third-party dependencies — built entirely on top of Apple's native framew
187204
## 🚀 Getting Started
188205

189206
```bash
190-
git clone https://github.com/aygundev/DevAtlasMac.git
207+
git clone https://github.com/kodzamani/DevAtlasMac.git
191208
cd DevAtlasMac
192209
open DevAtlasMac.xcodeproj
193210
```
@@ -222,7 +239,7 @@ DevAtlasMac/
222239
├── Models/ # Data models
223240
├── Components/ # Reusable SwiftUI components
224241
├── Extensions/ # Swift extensions & helpers
225-
└── *.lproj/ # Localization strings (10+ languages)
242+
└── *.lproj/ # Localization strings
226243
```
227244

228245
---

docs/ai_prompts.png

321 KB
Loading

docs/app.png

243 KB
Loading

docs/notebook.png

317 KB
Loading

docs/settings.png

234 KB
Loading

docs/stats.png

296 KB
Loading

0 commit comments

Comments
 (0)