Skip to content

Commit c2ab2d4

Browse files
committed
Added README
1 parent 3ffdda3 commit c2ab2d4

1 file changed

Lines changed: 39 additions & 0 deletions

File tree

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Node Modules Nuke
2+
3+
Because your disk space is finite, but dependency trees apparently aren't.
4+
5+
This is a simple Electron app that finds `node_modules` folders hiding in your system, tells you how much space they're wasting, and lets you delete them. You know, so you can have a clean slate before running `npm install` and filling it strictly back up again 10 minutes later.
6+
7+
## Features
8+
9+
- **Scan**: Crawls your directories. It might take a while. Filesystems are big.
10+
- **Review**: Sorts folders by size, so you can see which side project from 2019 is hoarding the most logic.
11+
- **Delete**: Removes selected folders. Gone. Poof. Until you need them again.
12+
13+
## How to use
14+
15+
1. Open the app.
16+
2. Select a directory to scan.
17+
3. Wait.
18+
4. Select the folders you want to delete.
19+
5. Click the button.
20+
21+
## Development
22+
23+
If you really feel the need to build this yourself:
24+
25+
1. Clone the repo.
26+
2. Run `npm install`. Yes, you have to download `node_modules` to build the tool that deletes `node_modules`.
27+
3. Run `npm start`.
28+
29+
To build a release:
30+
31+
```bash
32+
npm run build
33+
```
34+
35+
This uses `electron-builder`, so it handles Mac, Windows, and Linux. Theoretically.
36+
37+
## License
38+
39+
MIT. Do whatever you want with it.

0 commit comments

Comments
 (0)