@novelbrasil/diamond v1.0.0

Sumário

• Sobre
• Começando
• Tecnologias
• Autores

Sobre

Trazer facilidade é o principal foco da ferramenta. Nela há hooks que podem ser usados em qualquer arquivo, além de necessitar poucas linhas de código para sua inicilização. De início, o seu paradigma principal é orientação a objeto. Tenho planos para torna-la também flexível para outros tipos de paradigma, mas isso são planos futuros.

Como que funciona essa facilidade? Além dos hooks, há classes customizáveis que veem de uma classe abstrata. As routas já vem com uma classe base muito bem formulado, contudo, se desejar fazer uma de sua maneira ou para casos específicos, ela é totalmente usável e customizável. Isso vale principalmente para os controladores que não apresentam uma classe base, mas uma classe vazia e você definirá a classe base dela.

Começando

Pré requisitos

Se seu objetivo for ajudar em algo, é necessário ter Git, Node e um gerenciador de pacotes de sua preferência, por exemplo: pnpm

Caso só queira usar a ferramenta, então é necessário ter um projeto e executar o comando de instalação, por exemplo:

pnpm install diamond

Instalando

1. Clone o projeto:

git clone https://github.com/KingTimer12/diamond.git

2. Entre na pasta usando: cd diamond
3. Instale todas as dependências usando seu gerenciador de pacotes, exemplo:

pnpm install

4. Use o script build:dev para buildar e testar usando o examples.

pnpm build:dev

Tecnologias

• Prisma - Database Framework
• Fastify - Server Framework
• NodeJs - Server Environment

Autores

• @Aaron King - Ideia & programador principal