theneovimmer 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +71 -48
- package/assets/banner.png +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,79 +1,102 @@
|
|
|
1
|
-
|
|
1
|
+
<div align="center">
|
|
2
|
+
<img src="assets/banner.png" alt="TheNeovimmer CLI Banner" width="100%" />
|
|
2
3
|
|
|
3
|
-
|
|
4
|
-
[](https://opensource.org/licenses/MIT)
|
|
4
|
+
# TheNeovimmer CLI
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
**Your Interactive Terminal Portfolio Experience**
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
[](https://opensource.org/licenses/MIT)
|
|
9
|
+
[](https://www.npmjs.com/package/theneovimmer)
|
|
10
|
+
[](https://nodejs.org)
|
|
9
11
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
12
|
+
<p>
|
|
13
|
+
An immersive, terminal-based portfolio interface designed for developers who live in the CLI.<br/>
|
|
14
|
+
Built with ❤️ and ☕ by <strong>TheNeovimmer</strong>.
|
|
15
|
+
</p>
|
|
16
|
+
</div>
|
|
15
17
|
|
|
16
|
-
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## 🚀 Quick Start
|
|
17
21
|
|
|
18
|
-
Run the CLI
|
|
22
|
+
Run the CLI instantly without installation:
|
|
19
23
|
|
|
20
|
-
|
|
24
|
+
```bash
|
|
21
25
|
npx theneovimmer
|
|
22
|
-
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## ✨ Features
|
|
29
|
+
|
|
30
|
+
Experience a fully interactive TUI (Text User Interface) with:
|
|
23
31
|
|
|
24
|
-
|
|
32
|
+
- **🚀 View Top Projects**: Explore my latest and greatest showcased projects.
|
|
33
|
+
- **🌐 Visit Portfolio**: Seamlessly open my web portfolio in your default browser.
|
|
34
|
+
- **👤 About Me**: Get to know the developer behind the code.
|
|
35
|
+
- **📧 Send Email**: Quick action to open your mail client and get in touch.
|
|
36
|
+
- **💻 GitHub Profile**: Direct access to my GitHub contributions and repositories.
|
|
37
|
+
- **🎨 Premium UI**: Beautiful gradients, ASCII art, and smooth interactions.
|
|
25
38
|
|
|
26
|
-
|
|
39
|
+
## 📦 Installation
|
|
40
|
+
|
|
41
|
+
For frequent use, you can install the CLI globally:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
27
44
|
npm install -g theneovimmer
|
|
45
|
+
# or
|
|
46
|
+
yarn global add theneovimmer
|
|
47
|
+
# or
|
|
48
|
+
pnpm add -g theneovimmer
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Then run it from anywhere:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
28
54
|
theneovimmer
|
|
29
|
-
|
|
55
|
+
```
|
|
30
56
|
|
|
31
|
-
## 🎮
|
|
57
|
+
## 🎮 Usage
|
|
32
58
|
|
|
33
|
-
|
|
59
|
+
Navigate the menu using your arrow keys `↑` `↓` and press `Enter` to select an option.
|
|
34
60
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
61
|
+
```
|
|
62
|
+
? What would you like to do?
|
|
63
|
+
❯ 🚀 View Top Projects
|
|
64
|
+
👤 About Me
|
|
65
|
+
🌐 Visit Portfolio
|
|
66
|
+
📧 Send Email
|
|
67
|
+
💻 GitHub Profile
|
|
68
|
+
👋 Exit
|
|
69
|
+
```
|
|
41
70
|
|
|
42
71
|
## 🛠️ Tech Stack
|
|
43
72
|
|
|
44
|
-
This CLI is built
|
|
73
|
+
This CLI is built using a modern Node.js stack:
|
|
45
74
|
|
|
46
|
-
- **
|
|
47
|
-
- **Chalk
|
|
48
|
-
- **
|
|
49
|
-
- **
|
|
50
|
-
- **Gradient String
|
|
51
|
-
- **Open** - Open URLs in the browser
|
|
75
|
+
- **[Inquirer.js](https://github.com/SBoudrias/Inquirer.js)**: Interactive command line user interface.
|
|
76
|
+
- **[Chalk](https://github.com/chalk/chalk)**: Terminal string styling.
|
|
77
|
+
- **[Boxen](https://github.com/sindresorhus/boxen)**: Creating boxes in the terminal.
|
|
78
|
+
- **[Figlet](https://github.com/patorjk/figlet.js)**: ASCII art text.
|
|
79
|
+
- **[Gradient String](https://github.com/bokub/gradient-string)**: Beautiful color gradients.
|
|
52
80
|
|
|
53
|
-
##
|
|
81
|
+
## 🤝 Contributing
|
|
54
82
|
|
|
55
|
-
|
|
83
|
+
Contributions are welcome! If you have suggestions or find issues:
|
|
56
84
|
|
|
57
|
-
|
|
58
|
-
git
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
npm link
|
|
63
|
-
theneovimmer
|
|
64
|
-
\`\`\`
|
|
85
|
+
1. Fork the repository.
|
|
86
|
+
2. Create your feature branch (`git checkout -b feature/AmazingFeature`).
|
|
87
|
+
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`).
|
|
88
|
+
4. Push to the branch (`git push origin feature/AmazingFeature`).
|
|
89
|
+
5. Open a Pull Request.
|
|
65
90
|
|
|
66
91
|
## 📄 License
|
|
67
92
|
|
|
68
|
-
MIT
|
|
93
|
+
Distributed under the MIT License. See `LICENSE` for more information.
|
|
69
94
|
|
|
70
|
-
##
|
|
95
|
+
## ✍️ Author
|
|
96
|
+
|
|
97
|
+
**Ilyes Bouzayen**
|
|
71
98
|
|
|
72
99
|
- 🌐 Portfolio: [ilyes-bouzayen.vercel.app](https://ilyes-bouzayen.vercel.app)
|
|
73
100
|
- 💼 GitHub: [@TheNeovimmer](https://github.com/TheNeovimmer)
|
|
74
101
|
- 📧 Email: ilyesbouzayen@hotmail.com
|
|
75
102
|
- 🔗 LinkedIn: [ilyes-bouzayen](https://linkedin.com/in/ilyes-bouzayen)
|
|
76
|
-
|
|
77
|
-
---
|
|
78
|
-
|
|
79
|
-
⭐️ If you like this project, give it a star on GitHub!
|
|
Binary file
|