JSagon NodeJS Framework

Construa aplicações eficientes e escaláveis de maneira simples e rápida.

Instalação e Deploy

A instalação e a criação de um projeto é muito simples com a JSagon CLI. Sendo necessário apenas executar os seguintes comandos no terminal de sua preferência.

Para instalar o CLI, execute o comando a seguir:

npm i -g @jsagon/cli

Para criar um novo projeto, escolha o diretório de sua preferência, e execute o seguinte comando:

jsagon new nome-do-projeto

Ao rodar o comando anterior, algumas perguntas serão feitas, responda-as de acordo com a sua preferência.

Sendo elas até o momento essencialmente:

  • Qual linguagem utilizar? TypeScript ou JavaScript.
  • Qual View Engine utilizar? Handlebars ou EJS. Obs.: caso não tenha conhecimento sobre View Engine, não tenha receio, é bem simples.
  • Qual gerenciador de pacote utilizar para instalar as dependências? Npm, Yarn ou Manual. Obs.: é normal ocorrer uma demora na instalação devido a determinadas opções escolhidas e suas dependências.

A criação do projeto tendo sido finalizada com sucesso terá criado uma pasta com o nome do projeto escolhido e toda a estrutura padrão da framework. A arquitetura de pastas e arquivos será explicado no artigo Estrutura

# Instalação alternativa

Uma outra maneira de fazer o download do arcabouço do projeto é acessando https://github.com/jsagon/jsagon-nodejs-framework-examples.

Escolha o branch de acordo com a sua preferência e faça o clone ou download do código.

Rodando a aplicação

Alguns comandos já vem pré-definidos para execução no ambiente de desenvolvimento e servidor de produção. Na pasta do projeto você poderá executar os comandos abaixo.

Para ver o projeto em funcionamento no ambiente de desenvolvimento, execute:

npm run dev

Esse comando inicializará o servidor, e você poderá acessar o projeto a partir do seu browser em http://localhost:3000. Com esse comando específico para desenvolvimento, qualquer modificação que você faça nos arquivos, fará com que o servidor atualize automaticamente, agilizando assim o desenvolvimento.

Para criar a versão de produção do projeto, execute:

npm run build

Este comando irá criar uma pasta "dist" (de distribuição) com a versão final do seu código já transcompilado para funcionamento.

Para executar o código do ambiente de produção, rode:

npm run start

Basicamente isso, sem mistérios. Agora para se situar no projeto, vamos entender a Arquitetura de pastas e arquivos.