|
|
|
O objetivo dessa seção é dar uma breve informação sobre a estrutura do repositório, quais são os arquivos importantes e principalmente quais você deve editar para criar uma nova funcionalidade e aonde criar novos arquivos.
|
|
|
|
O objetivo dessa seção é dar uma breve informação sobre a estrutura do repositório, quais são os arquivos importantes, e principalmente, quais você deve editar para criar uma nova funcionalidade e onde criar novos arquivos.
|
|
|
|
|
|
|
|
Se você está desenvolvendo para o Blendb e adicionar novos arquivos, por favor, atualize a wiki, se necessário.
|
|
|
|
Se você está desenvolvendo e adicionando novos arquivos para o Blendb, por favor, atualize a wiki.
|
|
|
|
|
|
|
|
## Diretórios
|
|
|
|
|
|
|
|
* [artwork](desenvolvimento/repositório/artwork): Contém imagens relativas ao projeto como logos e imagens de parceiros e tecnologias utilizadas. Atualmente são usadas apenas no README.md para apresentação do projeto.
|
|
|
|
* [config](desenvolvimento/repositório/config): Contém arquivos de configuração do Blendb
|
|
|
|
* [coverage](desenvolvimenti/repositório/coverage): Esse diretório é gerado automáticamente ao executar testes automáticos
|
|
|
|
* [database](desenvolvimento/repositório/database): Contém arquivos relaacionados a compatibilidade do Blendb com o banco de dados
|
|
|
|
* [doc](desenvolvimento/repositório/doc): Contém a documentação da API do Blendb, que é egrado automáticamente
|
|
|
|
* [node_modules](desenvolvimento/repositório/node_modules): Contém as dependencias do projeto. Gerado automáticamente
|
|
|
|
* [scripts](desenvolvimento/repositório/scripts): Contém os scripts executados usando *npm run*, quando eles não cabem em uma linha
|
|
|
|
* [service](desenvolvimento/repositório/service): Contém os arquivos que descrevem o Blendb como um serviço do systemd. Gerado automaticamente
|
|
|
|
* [specs](desenvolvimento/repositório/specs): Contém a especificação da API do Blendb em formato RAML
|
|
|
|
* [src](desenvolvimento/repositório/src): Contém o código fonte do Blendb e alguns arquivos de teste
|
|
|
|
* [test](desenvolvimento/repositório/test): Contém configurações globais de testes e arquivos de fixtures
|
|
|
|
* [artwork](desenvolvimento/repositorio/artwork): Contém imagens relativas ao projeto como logos, imagens de parceiros e tecnologias utilizadas. Atualmente são usadas apenas no README.md para apresentação do projeto.
|
|
|
|
* [config](desenvolvimento/repositorio/config): Contém arquivos de configuração do Blendb.
|
|
|
|
* [coverage](desenvolvimenti/repositório/coverage): Esse diretório é gerado automaticamente ao executar os testes automáticos.
|
|
|
|
* [database](desenvolvimento/repositório/database): Contém arquivos relacionados à compatibilidade do Blendb com o banco de dados.
|
|
|
|
* [doc](desenvolvimento/repositório/doc): Contém a documentação da API do Blendb (gerado automaticamente).
|
|
|
|
* [node_modules](desenvolvimento/repositorio/node_modules): Contém as dependências do projeto (gerado automáticamente).
|
|
|
|
* [scripts](desenvolvimento/repositorio/scripts): Contém os scripts executados usando *npm run* quando eles não cabem em uma linha.
|
|
|
|
* [service](desenvolvimento/repositorio/service): Contém os arquivos que descrevem o Blendb como um serviço do systemd (gerado automaticamente).
|
|
|
|
* [specs](desenvolvimento/repositorio/specs): Contém a especificação da API do Blendb em formato RAML.
|
|
|
|
* [src](desenvolvimento/repositorio/src): Contém o código fonte do Blendb e alguns arquivos de teste.
|
|
|
|
* [test](desenvolvimento/repositorio/test): Contém configurações globais de testes e arquivos de fixtures.
|
|
|
|
|
|
|
|
## Arquivos
|
|
|
|
|
|
|
|
* **index.js**: Arquivo que inicializa o projeto, em JavaScript. Apenas incluí o arquivo de entrada do código fonte.
|
|
|
|
* **index.js**: Arquivo que inicializa o projeto, em JavaScript. Apenas inclui o arquivo de entrada do código fonte.
|
|
|
|
* **LICENSE**: Licença GPL3
|
|
|
|
* **nodemon.json**: Configuração para o pacote nodemon, que automaticamente recarrega o serviço quando os arquivos fonte são alterados. A principio não faz parte das dependências e não é utilizado, mas caso algum desenvolvedor ache interessante, a configuração já está feita.
|
|
|
|
* **package.json**: Descritor do npm, contém as dependências do projeto
|
|
|
|
* **README.md**: Arquivo que aparece na pagina inical do Gilab. Apresenta o projeto.
|
|
|
|
* **nodemon.json**: Configuração para o pacote nodemon, que automaticamente recarrega o serviço quando os arquivos fonte são alterados. A princípio não faz parte das dependências e não é utilizado, mas caso algum desenvolvedor ache interessante, a configuração já está feita.
|
|
|
|
* **package.json**: Descritor do npm, contém as dependências do projeto.
|
|
|
|
* **README.md**: Arquivo que aparece na pagina inical do Gilab apresentando o projeto.
|
|
|
|
* **tsconfig.json**: Arquivo de configuração o *transpilador* Typescript
|
|
|
|
* **tslint.json**: Arquivo para configuração do *linter* do projeto.
|
|
|
|
|
| ... | ... | |
