Skip to content

Commit f79b1c5

Browse files
author
Zota0
committed
Added readme
1 parent f610062 commit f79b1c5

1 file changed

Lines changed: 62 additions & 0 deletions

File tree

README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# NextJs CLI Helper Tool
2+
3+
## Help
4+
5+
Help with basics of NextJS, such as:
6+
- Initialization of NextJS
7+
- Running NextJS
8+
- Creating pages
9+
- Creating components
10+
- server
11+
- client
12+
- Creating Server Actions
13+
14+
15+
## Configuration
16+
17+
Command `Edit Config` - creates a config file in the root of the project, also you can modify:
18+
- "pagePath" - Path for new pages (default: src/app)
19+
- "actionPath" - Path for new actions (default: src/actions)
20+
- "componentPath" - Path for new components (default: src/components)
21+
- "style" - Style for new components (default: tailwind) (@NOTE: FOR NOW DOES NOTHING)
22+
- "packageManager" - Package manager (default: pnpm, options: bun, deno, npm, pnpm)
23+
24+
25+
## Instalation
26+
27+
```bash
28+
# Bun
29+
bun install nextcli-helper
30+
31+
# Npm
32+
npm install -g nextcli-helper
33+
34+
# Pnpm
35+
pnpm add -g nextcli-helper
36+
```
37+
38+
39+
## Usage
40+
41+
```bash
42+
nextcli
43+
```
44+
45+
```bash
46+
# Opens Tool's cli
47+
# (Use arrow keys to navigate choices)
48+
```
49+
50+
# Author
51+
52+
- (me) [BartekDeveloper](https://github.com/BartekDeveloper)
53+
54+
55+
# License
56+
57+
MIT
58+
59+
60+
# NPM
61+
62+
- [nextcli-helper](https://www.npmjs.com/package/nextcli-helper?activeTab=readme)

0 commit comments

Comments
 (0)