Instalação

Pré-Requisitos

O Sprout possui apenas dois pré-requisitos que você deve ficar atento antes da instalação:

• Compatibilidade apenas com banco MySQL, MariaDB, PostgreSQL, SQL Server ou Firebird;
• Versão do Scriptcase (opens new window) 9.0 ou superior.

Novo Projeto

Comece a usar agora mesmo o Sprout como o carro chefe dos seus sistemas. Para isso, saiba o passo a passo necessário para baixar, importar e pré-configurar o projeto em seu ambiente.

• Download
• Base de Dados
• Importação
• Conexão
• Projeto
• Assets
• Ativando o Sprout

Download

Após realizar o download, descompacte o arquivo.

O pacote possui scripts para MySQL, MariaDB, PostgreSQL, SQL Server ou Firebird, projeto para Scriptcase e uma pasta para imagens do projeto:

O arquivo ms_sprout.zip é o projeto para ser importado no Scriptcase, não há necessidade de descompactá-lo.

Os arquivos de extensão .sql são os scripts para a criação de tabelas no MySQL, MariaDB, PostgreSQL, SQL Server ou Firebird;.

Confira abaixo a lista de bancos de dados suportados e seus respectivos drivers:

Database	Driver
MySQL	PDO e MySQLi
MariaDB	PDO e MySQLi
PostgreSQL	PostgreSQL PDO
SQL Server	MSSQL Server Native SRV
Firebird	Firebird PDO

Observação:

Para saber mais sobre a pasta assets, veja aqui.

Base de dados

Vamos mostrar como realizar a configuração para um banco MySQL.

Escolha o seu gerenciador de banco preferido (nosso exemplo usará o Navicat) e então siga os passos abaixo:

1. Conecte-se a um banco de dados previamente configurado.

2. Crie uma base de dados com o nome sprout ou o nome que desejar.

Dê preferência ao uso do charset UTF-8 e o collation utf8_general_ci.

3. Abra a base de dados recém-criada e, com o botão direito do mouse, escolha a opção Execute SQL File.

4. Escolha o arquivo ms_sprout_mysql_pt_br.sql que você fez o download anteriormente e clique em OK.

Observação:
O Sprout disponibiliza scripts nos idiomas Português, Inglês e Espanhol.

5. O processo deve terminar sem erros. Com isso, todas as tabelas do Sprout serão importadas ao seu banco de dados MySQL.

Importação

Agora que você concluiu a base de dados, vamos importar o projeto para o seu Scriptcase.

Acesse o Scriptcase e siga as etapas abaixo:

1. Acesse Projeto → Importar Projeto.
2. Selecione o arquivo ms_sprout.zip.
3. Clique para importar. Nesta etapa, você será exibida uma tela de confirmação da importação do Sprout.

Nesta etapa, você também poderá renomear o nome projeto como desejar.

4. Em seguida, todas as aplicações serão carregadas e, ao término do processo, você deverá visualizar a seguinte tela:

5. Agora só resta confirmar a importação e então você terá acesso às aplicações do Sprout.

Observação:

Lembre-se de acessar às propriedades do projeto para alterar os valores iniciais do Sprout e informar os dados que se adéquem à sua finalidade.

Conexão

Nesta etapa vamos configurar a conexão de acordo com a sua base de dados.

1. Acessando o projeto no Scriptcase, clique em Editar conexão e selecione a conexão conn_sprout.

WARNING

Para bancos de dados diferentes de MySQL, é necessário excluir a conexão e criá-la novamente, selecionando o banco de dados desejado e nomeando-a como conn_sprout.

2. Conecte-se com a base de dados criada na etapa anterior.

Observação:

Lembre-se de selecionar nossa base de dados.

Projeto

Após todos esses passos, recomendamos que você troque as informações iniciais, carregadas com o Sprout, para os dados relativos ao seu projeto.

Para fazer isso, acesse o menu Projeto e clique em Propriedades.

Na próxima tela você tem a opção de customizar informações como descrição do projeto, ícone da aba do navegador (Favicon) e imagem, por exemplo. Saiba mais (opens new window)

Assets

Diretório padrão do Sprout

Por padrão, as aplicações do Sprout esperam que exista uma pasta assets criada no mesmo diretório onde se encontra a sua pasta scriptcase.

Portanto, após a importação do projeto, é recomendado que você:

• Copie a pasta assets, que pode ser encontrada no pacote;
• Adicione a pasta assets, no mesmo diretório da pasta scriptcase;

Esta é uma prática feita por nós para armazenarmos todos os arquivos de imagens e documentos em um único diretório. Assim, temos a facilidade de compartilhar do mesmo diretório em desenvolvimento e produção.

TIP

Explicando um pouco mais, essa é a estrutura:

assets/files/img/system - Armazena todas as imagens aplicadas na configuração do sistema.

assets/files/img/user - Armazena todas as imagens dos usuários.

assets/files/img/employee - Armazena todas as imagens dos funcionários.

assets/files/img/customer/person - Armazena todas as imagens dos clientes pessoa física.

assets/files/img/customer/company/contact - Armazena todas as imagens dos contatos de clientes pessoas jurídicas.

---

Diretório padrão do Scriptcase

Porém, caso você não deseje utilizar desta forma, você pode aplicar um outro diretório através da Aplicação → Edição Expressa, seguindo o passo abaixo:

Após a importação do projeto, é recomendado que você:

• Acesse o menu principal do Scriptcase em Configurações → Administração → Diretórios do Sistema;
• Copie os valores de Diretório para Documentos e Diretório para Imagens;
• Acesse o menu principal do Scriptcase em Aplicação → Edição Expressa;
• Atualize Diretório para Documentos e Diretório para Imagens de todas as aplicações do projeto Sprout;
• Adicione a pasta system, que pode ser encontrada na pasta assets, no seu Diretório para Imagens;

Diretório padrão do Scriptcase: /scriptcase/file/img

---

Para publicação, caso você queira manter as imagens de desenvolvimento, é necessário copiar todas as imagens do diretório assets/img e adicionar no mesmo diretório de imagens da publicação.

Lembrando que, para publicação típica, o diretório de imagens sempre será em _lib/file/img.

Já para a publicação avançada, é possível definir o caminho que as imagens serão armazenadas.

Observação:

Não confundir com a pasta __Assets da estrutura do projeto. Essa serve para recursos utilizados pelo Sprout como scripts, APIs, bibliotecas externas e outros.

Ativação

Agora que você já fez todas as configurações necessárias, falta realizar o último passo para ter acesso à interface e recursos que o Sprout oferece.

O nosso projeto semente vem, nativamente, bloqueado para o primeiro acesso, sendo necessária a ativação via código.

Esse é o código que você recebeu por e-mail, no momento da compra.

Siga o passo a passo abaixo para realizar a ativação.

Copie o código recebido por e-mail.

Após confirmação da sua compra, você deve receber um e-mail contendo o código para ativação.

Copie o código recebido.

Ative o Sprout

Execute o projeto ou a aplicação inicial signin.

Você verá imediatamente um pedido de desbloqueio.

Informe o e-mail utilizado na compra, o mesmo cadastrado no Hotmart, e cole o código de ativação.

Pronto!

O seu Sprout está ativado e pronto para uso.

---

Projeto Existente

Para migrar um projeto já existente que ainda não é Sprout, é necessário realizar a migração das tabelas do seu módulo de segurança antigo para o modelo utilizado por nós.

Para isso, você deve seguir as instruções disponíveis logo abaixo.

Porém, lembre-se de realizar todo o passo a passo da etapa Novo Projeto.

Migração de tabelas

Disponibilizamos uma aplicação para facilitar a conversão de uma base de dados de um projeto já existente para a estrutura usada no Sprout.

Adicionando o Sprout ao meu projeto

WARNING

Tenha em mente que a migração é de sua inteira responsabilidade e, por isso, aconselhamos a realização de um backup da sua base de dados antes de começar o processo abaixo.

1. Copie as aplicações extras do projeto antigo para o Sprout;

As aplicações extras são as aplicações que não fazem parte do módulo de segurança.

Atentar-se aos temas, templates HTML, bibliotecas e quaisquer outros componentes que possam estar sendo utilizados. Recomendamos a leitura do artigo sobre estrutura de pastas (opens new window).

2. Exportar todas as tabelas da base de dados do projeto antigo;

WARNING

A aplicação migration apenas faz a migração dos dados de uma tabela para outra tabela da mesma base de dados.

Para diferentes bancos de dados como MySQL e PostgreSQL, por exemplo, é necessário que seja feita a conversão de toda a estrutura e dados para o mesmo banco de dados.

3. Importar na base de dados do Sprout;

Recomendado aplicar um prefixo como ms_ para evitar conflito nas tabelas.

4. Executar a aplicação migration localizada na pasta __Assets;
5. Preencher todas as informações relacionadas as tabelas e colunas, mediante do módulo de segurança utilizado no projeto antigo;
6. Realize a migração da base de dados;

Pronto!

O seu Sprout está pronto para uso.

Agora administre os menus em Sistema → Gerenciamento de Menus e também os grupos, os associando aos menus em Departamento → Lista de Departamentos.

---

Atualização do Sprout

Se você já utiliza o Sprout em algum projeto e deseja atualizar para a versão mais recente disponibilizada, basta importa o arquivo ZIP da nova versão em seu ambiente e então seguir apenas o primeiro passo descrito no tópico "Projeto existente".

Para exemplificar, digamos que você possua um projeto chamado "Sprout".

Ao importar a nova cópia do Sprout, ou seja, o arquivo com a versão mais atualizada, você deverá dar um nome diferente para esse projeto.

Neste exemplo: "Sprout_2".

Agora que você possui "Sprout" e "Sprout_2" em seu ambiente, você deverá copiar as aplicações extras do projeto mais antigo para o mais novo.

Com o termo aplicações extras, estamos nos referindo apenas às aplicações que não são nativas do Sprout.

Após finalizado esse processo, vá na conexão do pojeto "Sprout_2" e edite a conexão com os dados corretos.

Ao fim do processo, você terá dois projetos, "Sprout" inalterado e "Sprout_2" com as aplicações e os dados do projeto antigo, mas atualizado para nova versão e, sendo assim, com todos os novos recursos e homologações disponíveis.

Se desejar manter o nome antigo na nova versão do projeto, é necessário seguir os passos abaixo (além dos já mencionados), já que o Scriptcase não permite a renomeação de projeto:

1. Faça backup e exporte os dois projetos;

2. Após exportação, apague os projetos de seu ambiente e importe novamente apenas o arquivo de backup do "Sprout_2", renomeando para "Sprout".

Obs: Se você realizou alterações nas aplicações nativas do Sprout e deseja mantê-las, recomendamos que copie o conteúdo alterado e leve para o novo projeto de forma manual, a fim de evitar que o conteúdo das aplicações da versão mais atualizada não seja comprometido.

---

Novas Aplicações

Para novas aplicações ou até mesmo aplicações migradas de outro projeto, é necessário seguir alguns padrões para que as aplicações funcionem corretamente.

Títulos das Páginas

Para aplicar o título das páginas é necessário utilizar a função appSetting() no evento onScriptInit das aplicações. A função appSetting() aplica o nome da aplicação na barra de ferramentas da página.

Para não haver conflitos, não utilize botões no lado esquerdo da barra de ferramentas superior.

Para aplicações copiadas de outros projetos, certifique-se de que a biblioteca interna appSetting está habilitada nas configurações da aplicação.

WARNING

Desabilite a opção Exibir output Ajax nas configurações da aplicação.

Aplicando o título das páginas no onScriptInit das aplicações

appSetting();

Caminho de navegação

Por padrão, nós também criamos uma lang, para aplicar no cabeçalho da aplicação. Pois, o caminho de navegação do menu utiliza o conteúdo do cabeçalho para criar o link.

1. Acesse Traduzir aplicações na pasta Mensagens do projeto → apps

2. Crie a lang como lang_<nome da aplicação>_name

3. Utilize essa mesma lang no cabeçalho da aplicação.