Este guia detalha a estrutura, inicialização e configuração do projeto san-update.
Estrutura de Diretórios
san-update/
├── README.md
├── package.json
├── src/
│ ├── index.js
│ ├── config/
│ │ ├── default.json
│ │ ├── production.json
│ ├── utils/
│ │ ├── helper.js
│ ├── routes/
│ │ ├── api.js
├── public/
│ ├── index.html
│ ├── assets/
│ │ ├── css/
│ │ ├── js/
│ │ ├── images/
- README.md: Contém a descrição do projeto e instruções de uso.
- package.json: Gerencia as dependências e scripts do projeto.
- src/: Código fonte.
- index.js: Ponto de entrada da aplicação.
- config/: Arquivos de configuração.
- default.json: Configurações padrão.
- production.json: Configurações para ambiente de produção.
- utils/: Funções utilitárias.
- helper.js: Funções auxiliares.
- routes/: Aqruivos de rota.
- api.js: Define as rotas da API.
- public/: Recursos estáticos.
- index.html: Página principal.
- assets/: Diretório de assets.
- css/: Arquivos CSS.
- js/: Arquivos JavaScript.
- images/: Arquivos de imagem.
Arquivo de Inicialização
O arquivo principle para iniciar a aplicação é src/index.js. Ele é responsável por configurar a aplicação, carregar as configurações e iniciar o servidor.
const express = require('express');
const appConfig = require('./config');
const apiRoutes = require('./routes/api');
const serverApp = express();
// Carrega a configuração
serverApp.set('appConfig', appConfig);
// Configura as rotas da API
apiRoutes(serverApp);
// Inicia o servidor
const portNumber = process.env.PORT || 3000;
serverApp.listen(portNumber, () => {
console.log(`Servidor rodando na porta ${portNumber}`);
});
Arquivos de Configuração
Os arquivos de configuração estão localizados em src/config/.
default.json
Este arquivo contém as configurações padrão da aplicação.
{
"serverInfo": {
"listenPort": 3000
},
"dbConnection": {
"host": "localhost",
"port": 27017,
"dbName": "san-update"
}
}
production.json
Este arquivo contém configurações específicas para o ambiente de produção.
{
"serverInfo": {
"listenPort": 8080
},
"dbConnection": {
"host": "prod-db.example.com",
"port": 27017,
"dbName": "san-update-prod"
}
}
Esses arquivos permitem gerenciar as configurações de forma flexível para diferentes ambientes, garantindo a operação correta do projeto em cada um deles.