Bem vind@ ao repositório para o servidor da AlocaNet, um serviço de gerenciamento e locação de espaços para condomínios.
• NodeJs: Framework utilizado para desenvolver a API.
• MongoDB: Banco de Dados NoSQL
• ApiDoc: Biblioteca de documentação de API via JS-Docs
Você pode acessar a documentação mais atual da nossa API através desse site.
Para configurar e inicializar o ambiente de desenvolvimento do servidor AlocaNet, é necessário ter instalado o Node (> v16.0.0), juntamente com o npm (> v8.0.0).
Na pasta raíz do diretório, execute os scripts abaixo:
// Instalação de dependências
npm install
Após feita a instalação, tudo que resta é criar um arquivo .env na raíz do diretório, onde deverão ser criadas as chaves
Chaves | Descrição do Valor |
---|---|
SERVER_PORT |
{String} Porta do Servidor |
DB_URI |
{String} URI de acesso ao Mongodb |
JWT_ACCESS_TOKEN_SECRET |
{String} Segredo para geração de JWTs |
Com isso só resta executar o comando abaixo para inicializar o servidor em http://localhost:SERVER_PORT
// Inicializando o servidor
npm run start