https://github.com/thiagowaib/alocanet-servidor

Repositório para o Servidor do sistema AlocaNet
https://github.com/thiagowaib/alocanet-servidor

Last synced: about 2 months ago
JSON representation

Repositório para o Servidor do sistema AlocaNet

• Host: GitHub
• URL: https://github.com/thiagowaib/alocanet-servidor
• Owner: thiagowaib
• License: mit
• Created: 2022-09-02T00:57:32.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-27T19:53:02.000Z (about 2 years ago)
• Last Synced: 2023-06-14T02:37:40.452Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 852 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Servidor *AlocaNet*



> Bem vind@ ao repositório para o servidor da AlocaNet, um serviço de gerenciamento e locação de espaços para condomínios.




## 👨‍💻 Desenvolvido utilizando

  •  **NodeJs**: Framework utilizado para desenvolver a API.

 • **MongoDB**: Banco de Dados NoSQL

 • **ApiDoc**: Biblioteca de documentação de API via JS-Docs




## 📄 Documentação

Você pode acessar a documentação mais atual da nossa API **[através desse site](https://alocanet-servidor.glitch.me/ "através desse site")**.




## 🚀 Inicialização de ambiente

Para configurar e inicializar o ambiente de desenvolvimento do servidor AlocaNet, é necessário ter instalado o **[Node](https://nodejs.org/en/ "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](https://www.freecodecamp.org/portuguese/news/como-usar-variaveis-de-ambiente-do-node-com-um-arquivo-dotenv-para-node-js-e-npm/ ".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




## 🤝 Colaboradores

 **[ • Thiago Waib](https://github.com/thiagowaib " • Thiago Waib")**

 **[ • Felipe Ferrari](https://github.com/felipeferrari22 " • Felipe Ferrari")**

 **[ • Renan Henrique](https://github.com/xjfgames " • Renan Henrique")**

 **[ • Erik Basso](https://github.com/Erik-Basso " • Erik Basso")**