@grafe/grafe-cli
Advanced tools
Readme
The easiest way to create a backend
Either through cloning with git or by using npm (recommended way):
npm install -g @grafe/grafe-cli
This is a simple tutorial of how to use grafe. It will teach you how to start a new Project, how you can add new components and many other things.
Welcome to grafe!
If you have already installed the package @grafe/grafe-cli, we will start by creating a new Grafe project. For this we use the grafe start command with the integrated options, which you can have a look at in the documentation under syntax.
grafe start HelloWorld -t express --yes
As template we use express and as project name we take 'HelloWorld'.
To check if everything worked correctly, we run the project with the grafe serve command. By the way, this command detects if you have made a change, then re-compiles the project and restarts it.
grafe serve
If you have not changed the port, your back-end is now running on port 3000 with a default route
GET localhost:300/index/ which does nothing.
Let us now create our first route, which should greet us with a Hello World.
For this we use the grafe generate route command with its integrated options, which you can read again in the documentation under syntax.
grafe generate route -r /helloworld/greet -m get -w --yes
Now we have a new file under src/routes/helloworld/. The contents of this file look like this:
import { Request, Response } from 'express';
export = async (req: Request, res: Response) => {
};
To see a result we now write a response into the function:
res.send({ message: 'hello world'});
We can test it with our browser, since it is a GET method, or with Postman. If you want to test the route with your browser, go to the url http://localhost:3000/helloworld/greet/.
The next step is to take a closer look at middleware. This allows another function to be called before the route function is called. We create one with the grafe generate middleware command with its integrated options, which can be found in the documentation under syntax.
grafe generate middleware -n grafe-greets -s grf -d "This middleware will greet grafe" --yes
This creates a new file for us under src/middlewares/grf/grafe-greets.ts with the following content:
import { NextFunction, Request, Response } from 'express';
export = (req: Request, res: Response, next: NextFunction) => {
next();
}
To see that this middleware is called we first write a simple console.log which should output a message to the console:
console.log('Grafe greets!');
We write this above the next() method. Now we generate a new route with our new middleware preceding:
grafe generate route -r /helloworld/grafe -m get -w grf --yes
In this route we write the same response as in generate your first route. If we now call this route via our browser (http://localhost:3000/helloword/grafe/), we see our 'hello world' in the browser and a 'Grafe greets!' in our console.
Creates a new grafe project.
grafe start [projectName]
grafe start will start the prompts to create a new grafe project.
| Option | Alias | Description |
|---|---|---|
| --help | - / - | Shows a list of all available options |
| --template | -t | Sets the template of the project |
| --testing | - / - | Enables testing for the grafe project |
| [projectName] | - / - | Sets the project name |
| --yes | - / - | confirms the creation of the new project |
grafe start project_1
grafe start project_2 -t express
grafe start project_3 --testing
Creates a new grafe component.
grafe generate
grafe generate will start the prompts of which component should be generated.
| Option | Alias | Description |
|---|---|---|
| --help | - / - | Shows a list of all available options |
| route | - / - | Will generate a new route |
| middleware | - / - | Will generate a new middleware |
| static | - / - | Will generate a new static-directory |
grafe generate
grafe generate --help
grafe generate route
Automatically creates a new grafe-route-component,
grafe generate route
grafe generate route will start the prompts of the route properties and automatically generate a new route component.
| Option | Alias | Description |
|---|---|---|
| --help | - / - | Shows a list of all available options |
| --routePath | -r | Sets the path of the new route |
| --method | -m | Sets the method of the new route. `get |
| --middlewares | -w | Sets the preceding middlewares of the route |
| --yes | - / - | confirms the generation of the new component |
grafe generate route
grafe generate route --help
grafe generate route -r /auth/login -m post
grafe generate route -r /auth/is-authenticated -m get -w pt --yes
Automatically creates a new grafe-middleware-component
grafe generate middleware
grafe generate middleware will start the prompts of the middleware properties and automatically generate a new middleware component.
| Option | Alias | Description |
|---|---|---|
| --help | - / - | Shows a list of all available options |
| --name | -n | Sets the name of the middleware |
| --short | -s | Sets the shortcut of the middleware |
| --description | -d | Sets the description of the middleware |
| --yes | - / - | confirms the generation of the new component |
grafe generate middleware
grafe generate middleware --help
grafe generate middleware -n protected -s pt
grafe generate middleware -n admin-only -s adm -d "Only for Admins" --yes
Creates a new folder which can be used for static files.
grafe generate static
grafe generate static will start the prompts of the static properties and automatically create a new static directory.
| Option | Alias | Description |
|---|---|---|
| --help | - / - | Shows a list of all available options |
| --name | -n | Sets the name of new folder |
| --prefix | -p | Sets the prefix with which you access the folder |
| --yes | - / - | confirms the generation of the new component |
grafe generate static
grafe generate static --help
grafe generate static -n images
grafe generate static -n pictures -p public/pictures --yes
Starts the project and watches for file changes.
grafe serve
grafe serve will start the project, watches for file changes, re-compiles and restarts it.
| Option | Alias | Description |
|---|---|---|
| --help | - / - | Shows a list of all available options |
grafe serve
| Project | Package | Version |
|---|---|---|
| Garfe CLI | @garfe/grafe-cli |  |
| Grade Core | @garfe/grafe-core |  |
MIT
FAQs
This is the CLI of grafe.With this you can easily create a new project, generate new components and start your back-end.
The npm package @grafe/grafe-cli receives a total of 0 weekly downloads. As such, @grafe/grafe-cli popularity was classified as not popular.
We found that @grafe/grafe-cli demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.