DEV Community

Florian Woelki
Florian Woelki

Posted on

VGQL CLI

The main goal of the VGQL command line tool, is to simplify the process of generating a project for a Vue.js and GraphQL techstack.

Currently, the following techstack is supported:

  • JavaScript/TypeScript
  • GraphQL (with TypeGraphQL)
  • TypeORM
  • Vue.js

In the future there will be Nuxt.js and other ORM extras you can generate your project with.

Why VGQL

Whenever I create a new fullstack project with Vue.js and GraphQL, every time I do the same thing. Installing TypeGraphQL, set TypeScript up and setup your database connection with TypeORM. Therefore, I made this CLI to simplify this process in a dynamic way.

Right now, there is not much dynamic, because the projects get generated with my default settings. But this will change in the future.

How to use VGQL

It is pretty straightforward. You just install the CLI globally and run it. After that it will generate two directories (web and server). The web directory contains the Vue.js application and the server directory contains the GraphQL back-end. Furthermore, the connection is already setup, so you just need to start both services and you are ready to go.

Install the CLI:

npm install -g vgql
Enter fullscreen mode Exit fullscreen mode

Start the CLI:

vgql
Enter fullscreen mode Exit fullscreen mode

Start the web application:

cd web/
npm run serve
OR
yarn serve
Enter fullscreen mode Exit fullscreen mode

Start the server application:

cd server/
npm run start
OR
yarn start
Enter fullscreen mode Exit fullscreen mode

Can you contribute?

Of course! You can contribute by helping to improve the code quality or writing tests. Go on GitHub and start coding!

What do you think about this CLI? Is it useful?

Thank you for reading :)

Top comments (0)