Lumus Js

Summary | Sumário

• Lumus JS EN-US
  • Installation
  • Usage
    • Init Command
    • Generate Command
  • Example
  • Contributing
  • License
  • Contact
• Lumus JS PT-BR
  • Instalação
  • Uso
    • Comando Init
    • Comando Generate
  • Exemplo
  • Contribuindo
  • Licença
  • Contato

Lumus JS EN-US

Lumus JS is a powerful CLI tool designed to enhance your ExpressJS development workflow by providing scaffold-like functionality. Inspired by Rails, Lumus JS simplifies the process of creating and managing ExpressJS projects, offering seamless integration with TypeScript and various database options.

Installation

To install Lumus JS, make sure you have Node.js installed on your machine. Then, open your terminal and run the following command:

npm install lumusjs (to use locally)

Usage

Once your project is set up, Lumus JS provides a variety of commands to help you generate and manage your application's entities.

Init Command

To use Lumus JS, make sure you have Node.js installed on your machine. Then, open your terminal and run the following command:

npx lumus init [project-name] [--typescript] [--database <database>]

• project-name: The name of your project. This will create a new directory with the specified name and set up Lumus JS within it.
• --typescript (optional): Include this flag if you want to set up your project with TypeScript support.
• --database <database> (optional): Specify the database you want to use for your project. Replace <database> with one of the supported database options: postgres, mysql, oracle, or sqlite.
• --prisma (optional): Include this flag to use Prisma as the default ORM for your application. This is only applicable when using the --typescript flag.

Generate Command

To generate a new entity, use the following command:

npx lumus generate [entity-name] [attributes in the format name:type] [--typescript] [--prisma]

• entity-name: The name of the entity you wish to generate. Lumus JS will create the necessary files and boilerplate code for this entity.
• attributes: A list of attributes for the entity, specified in the format name:type. You can include multiple attributes, separated by spaces.
• --typescript (optional): Include this flag if you want the generated code to be in TypeScript.
• --prisma (optional): Include this flag to use Prisma as the default ORM for your application. This is only applicable when using the --typescript flag.

Supported attribute types:

• string
• integer
• decimal
• boolean
• date
• time
• datetime
• timestamp
• text

Example

Let's walk through an example to demonstrate the usage of Lumus JS.

1. Create a new project named "my-express-app" with Lumus JS:

npx lumus init my-express-app --typescript --prisma --database postgres

This will create a new directory called "my-express-app" and set up Lumus JS within it, configured with TypeScript and PostgreSQL as the database.

2. Generate a new entity named "User" with attributes "name" (string) and "age" (integer):

npx lumus generate User name:string age:integer --typescript --prisma

Lumus JS will generate the necessary files and code for the "User" entity, including TypeScript typings. Additionally, the --prisma flag is used to configure Prisma as the default ORM for the application.

Contributing

If you encounter any issues or have suggestions for improvements, please feel free to open an issue on the Lumus JS GitHub repository. We appreciate your contributions to make Lumus JS even better!

License

Lumus JS is released under the MIT License. See the LICENSE file for more details.

Contact

For any questions or inquiries, you can reach out to the Lumus JS development team at [email protected]. We would love to hear from you!

Thank you for choosing Lumus JS! We hope it simplifies and enhances your ExpressJS development experience. Happy coding!

Lumus JS PT-BR

Lumus JS é uma poderosa ferramenta de linha de comando (CLI) projetada para aprimorar o fluxo de trabalho de desenvolvimento com ExpressJS, fornecendo funcionalidades semelhantes a um scaffold. Inspirado pelo Rails, o Lumus JS simplifica o processo de criação e gerenciamento de projetos ExpressJS, oferecendo integração perfeita com TypeScript e várias opções de bancos de dados.

Instalação

Para instalar o Lumus JS, verifique se você tem o Node.js instalado em sua máquina. Em seguida, abra o seu terminal e execute o seguinte comando:

npm install lumusjs (para usar localmente)

Uso

Depois de configurar o seu projeto, o Lumus JS fornece uma variedade de comandos para ajudar a gerar e gerenciar as entidades da sua aplicação.

Comando Init

Para usar o Lumus JS, verifique se você tem o Node.js instalado em sua máquina. Em seguida, abra o seu terminal e execute o seguinte comando:

npx lumus init [nome-do-projeto] [--typescript] [--database <banco-de-dados>]

• nome-do-projeto: O nome do seu projeto. Isso criará um novo diretório com o nome especificado e configurará o Lumus JS nele.
• --typescript: (opcional): Inclua essa flag se você deseja configurar o seu projeto com suporte ao TypeScript.
• --database <banco-de-dados>: (opcional): Especifique o banco de dados que você deseja usar em seu projeto. Substitua por uma das opções de bancos de dados suportados: postgres, mysql, oracle ou sqlite.
• --prisma: (opcional): Inclua essa flag para usar o Prisma como o ORM padrão para a sua aplicação. Isso só é aplicável ao usar a flag --typescript.

Comando Generate

Para gerar uma nova entidade, use o seguinte comando:

npx lumus generate [nome-da-entidade] [atributos no formato nome:tipo] [--typescript] [--prisma]

• nome-da-entidade: O nome da entidade que você deseja gerar. O Lumus JS criará os arquivos e códigos necessários para essa entidade.
• atributos: Uma lista de atributos para a entidade, especificados no formato nome:tipo. Você pode incluir vários atributos, separados por espaços.
• --typescript: (opcional): Inclua essa flag se você deseja que o código gerado seja em TypeScript.
• --prisma: (opcional): Inclua essa flag para usar o Prisma como o ORM padrão para a sua aplicação. Isso só é aplicável ao usar a flag --typescript.

Tipos de atributos suportados:

• string
• integer
• decimal
• boolean
• date
• time
• datetime
• timestamp
• text

Exemplo

Vamos percorrer um exemplo para demonstrar o uso do Lumus JS.

1. Crie um novo projeto chamado "meu-app-express" com o Lumus JS:

npx lumus init my-express-app --typescript --prisma --database postgres

Isso criará um novo diretório chamado "meu-app-express" e configurará o Lumus JS nele, com TypeScript e PostgreSQL como banco de dados.

2. Gere uma nova entidade chamada "Usuário" com os atributos "nome" (string) e "idade" (integer):

npx lumus generate User nome:string idade:integer --typescript --prisma

O Lumus JS gerará os arquivos e código necessários para a entidade "Usuário", incluindo definições de tipos em TypeScript. Além disso, a flag --prisma é usada para configurar o Prisma como o ORM padrão para a aplicação.

Contribuindo

Se você encontrar algum problema ou tiver sugestões para melhorias, sinta-se à vontade para abrir uma issue no repositório do Lumus JS no GitHub. Agradecemos suas contribuições para tornar o Lumus JS ainda melhor!

Licença

O Lumus JS é lançado sob a Licença MIT. Consulte o arquivo LICENSE para obter mais detalhes.

Contato

Para qualquer dúvida ou pergunta, você pode entrar em contato com a equipe de desenvolvimento do Lumus JS em [email protected]. Ficaremos felizes em ouvir você!

Obrigado por escolher o Lumus JS! Esperamos que ele simplifique e aprimore sua experiência de desenvolvimento com ExpressJS. Feliz codificação!