You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,4 +10,4 @@ To get ready to work on the codebase, please do the following:
10
10
2. Run `pnpm install --frozen-lockfile` ([install](https://pnpm.io/installation))
11
11
3. Make your changes
12
12
4. Run `pnpm format && pnpm build && pnpm test:unit` to run ESLint/Prettier, build and tests
13
-
5.[Submit a pull request](https://github.com/NanoForge-dev/schematics/compare) (Make sure you follow the [conventional commit format](https://github.com/NanoForge-dev/CLI/blob/main/.github/COMMIT_CONVENTION.md))
13
+
5.[Submit a pull request](https://github.com/NanoForge-dev/schematics/compare) (Make sure you follow the [conventional commit format](https://github.com/NanoForge-dev/schematics/blob/main/.github/COMMIT_CONVENTION.md))
@@ -17,9 +19,9 @@ This repository contains the Schematics of NanoForge. Check [releases][github-re
17
19
18
20
## Usage
19
21
20
-
To use Nanoforge Schematics, please refer to the [Schematics documentation][cli-source] !
22
+
To use Nanoforge Schematics, please refer to the [CLI documentation][cli-source] !
21
23
22
-
First, install the Schematics :
24
+
First, install the CLI :
23
25
24
26
```bash
25
27
npm install -g @nanoforge-dev/cli
@@ -31,63 +33,14 @@ And then create a new project :
31
33
nf new
32
34
```
33
35
34
-
## Commands
36
+
## Schematics
35
37
36
-
The nanoforge client interface has multiple commands usable :
38
+
This repository provide multiples schematics, usable with Angular Devkit schematics.
37
39
38
-
```sh
39
-
nf [command] [options]
40
-
```
41
-
42
-
### `build`
43
-
44
-
Used to build your nanoforge project.
45
-
46
-
`-d, --directory [directory]` specify the directory of the nanoforge project to build.
47
-
`-c, --config [config]` path to the config file.
48
-
`--client-outDir [clientDirectory]` specifies the client directory.
49
-
`--server-outDir [serverDirectory]` specifies the server directory.
50
-
51
-
### `generate`
52
-
53
-
Used to generate nanoforge project files from config
54
-
55
-
`-d, --directory [directory]` specify the directory of the nanoforge project to build.
56
-
`-c, --config [config]` path to the config file.
57
-
58
-
### `install` or `add`
59
-
60
-
Used to add a nanoforge library to your project
61
-
62
-
`-d, --directory [directory]` specify the directory of the nanoforge project to build.
63
-
64
-
### `new`
65
-
66
-
Used to create a new nanoforge project
67
-
68
-
`-d, --directory [directory]` specify the directory of your project
69
-
`--name [name]` specify the name of your project
70
-
`--path [path]` specify the path of your project
71
-
`--package-manager [packageManager]` specify the package manager of your project
72
-
`--language [language]` specify the language of your project
73
-
`--strict` use strict mode
74
-
`--no-strict` do not use strict mode
75
-
`--server` create a server
76
-
`--no-server` do not create a server
77
-
`--init-functions` initialize functions
78
-
`--no-init-functions` do not initialize functions
79
-
`--skip-install` skip installing dependencies
80
-
`--no-skip-install` do not skip installing dependencies
81
-
82
-
### `start`
83
-
84
-
Used to start your nanoforge project
85
-
86
-
`-d, --directory [directory]` specify the directory of your project
87
-
`-c, --config [config]` path to the config file (default: "nanoforge.config.json")
88
-
`-p, --client-port [clientPort]` specify the port of the loader (the website to load the game)
89
-
`--game-exposure-port [gameExposurePort]` specify the port of the game exposure
90
-
`--server-port [serverPort]` specify the port of the server
40
+
-`application` : Base of a Nanoforge app
41
+
-`configuration` : Template of `nanoforge.config.json` with premade fields
42
+
-`part-base` : Base of Nanoforge client or server
43
+
-`part-main` : Client or server `main.ts` from a config
91
44
92
45
## Contributing
93
46
@@ -97,8 +50,8 @@ Please read through our [contribution guidelines][contributing] before starting
97
50
98
51
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please ask on [Discussions][discussions].
0 commit comments