Giter VIP home page Giter VIP logo

nest-generator's Introduction

NestG

NestG é uma ferramenta desenvolvida em Xtext para facilitar o desenvolvimento de webservices em NestJS com TypeORM.

Features

A ferramenta gera automaticamente:

  • Controllers
  • Services
  • Providers
  • Entities e/ou DTOs
  • Modules ( incluindo app.module )
  • Database Module
  • Dockerfile
  • sonar-project.properties
  • .gitlab-cy.yml
  • package.json
  • .env.example
  • main.ts

Instalação e uso

Atualmente, existe apenas uma forma de instalação e uso, pelo Eclipse

Eclipse

Pré-requisitos

Os seguintes tópicos são necessários já estarem instalados e configurados.

  • Eclipse
  • Eclipse DSL Tools

Instalação

  1. Clonar a branch master desse repositório 1.1 Para clonar pelo Eclipse (recomendado), vá em File > Import > Projects from Git > Clique em next > Clone URI. E então preencha a URI com o link deste repositório (autenticação necessária). 1.2 Em seguida, deixe todas as pastas marcadase clique em finish
  2. Com o projeto baixado, basta compilar a linguagem, vá até o arquivo nest_dsl > src > prodest.es.gov.br.dsl > Clique com o direito em NestDsl.xtext > Run as > Generate Xtext Artifacts Generate artifacts

Configuração

Para fazer a configuração e uso da ferramenta, realize os seguintes passos:

  1. Clique com direito em nest_dsl > Run as > Eclipse Application
  2. Crie um projeto (pode ser um projeto java) Clique em File > new > Java Project
  3. Clique com o direito no projeto recém criado e vá Configure > Convert to Xtext Project

Uso

Pré-requisitos
  • Ter iniciado um projeto com o NestJS

Agora basta criar um arquivo dentro de /src, com o nome que desejar, desde que tenha a extensão .nestg e definir suas entidades nesse arquivo. Os arquivos gerados estarão /src-gen

Exemplo de uso

Dentro de /src foi criada um entidade de examplo.
Input

Assim que a entidade for salva (CTRL+S), ela será compilada, se não existir nenhum erro de gramática, a seguinte estrutura será gerada:
Input

Documentação

Para uma documentação mais detalhada da gramática, acesse a wiki

Arquitetura gerada

O código gerado pelo NestG tem a seguinte arquitetura base: Arquitetura
Todos os modulos gerados herdam desse modulo genérico, que contém todas as funcionalidades relacionadas aos CRUDs.

nest-generator's People

Contributors

matheusrbarbosa avatar

Watchers

James Cloos avatar

Forkers

ledsifes

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.