|
|
| [Home](home) | [Escopo](escopo) | [Gerência](gerência) | [Processo](processo) | [Mockups](mockups) | [Configuração](configuração) | [Arquitetura](arquitetura) | [DataBase](database) |[Infra](infraestrutura) | [Estudos](estudos) |
|
|
|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|
|
|
|
|
|
|
|
|
|
|
|
<br />
|
|
|
<div align="center">
|
|
|
|
|
|
<!-- <a href="">
|
|
|
<img src="" alt="Decola" width="150">
|
|
|
</a> -->
|
|
|
|
|
|
<h3 align="center">Configuração BACKEND</h3>
|
|
|
|
|
|
<p align="center">
|
|
|
Backend do projeto Decola desenvolvido na AGES no segundo semestre de 2024.
|
|
|
<br />
|
|
|
<br />
|
|
|
<a href="#-getting-started">Getting Started</a>
|
|
|
·
|
|
|
<a href="#-installation">Installation</a>
|
|
|
·
|
|
|
<a href="#-run">Run</a>
|
|
|
·
|
|
|
<a href="#-developing">Developing</a>
|
|
|
·
|
|
|
<a href="#-documentation">Documentation</a>
|
|
|
·
|
|
|
<a href="#-running-tests">Running Tests</a>
|
|
|
·
|
|
|
<a href="#-deploy">Deploy</a>
|
|
|
<br />
|
|
|
<br />
|
|
|
</p>
|
|
|
</div>
|
|
|
|
|
|
---
|
|
|
|
|
|
## 🛠 Getting Started
|
|
|
|
|
|
Instale os pré-requisitos
|
|
|
|
|
|
[<img src="./docs/assets/nodejs_logo.png" width="60">](https://nodejs.org/)
|
|
|
`v20.11.*`
|
|
|
|
|
|
---
|
|
|
|
|
|
## ⚙️ Installation
|
|
|
É necessário fazer a instalação e configuração do
|
|
|
[Docker](https://docs.docker.com/desktop/install/windows-install/).
|
|
|
|
|
|
Para instalar as dependências do projeto basta apenas rodar o seguinte comando na pasta raiz:
|
|
|
|
|
|
```shell
|
|
|
npm install
|
|
|
```
|
|
|
|
|
|
---
|
|
|
|
|
|
## 🚀 Run
|
|
|
|
|
|
Primeiro rode o Docker-compose para subir o container do banco e do pg-Admin
|
|
|
|
|
|
```shell
|
|
|
docker-compose up -d
|
|
|
```
|
|
|
|
|
|
Para rodar o projeto utilize o seguinte comando
|
|
|
|
|
|
```shell
|
|
|
npm run start
|
|
|
```
|
|
|
|
|
|
---
|
|
|
|
|
|
## 🧑🏼💻 Developing
|
|
|
|
|
|
Para criar um script de migração, rode:
|
|
|
|
|
|
```shell
|
|
|
db-migrate
|
|
|
```
|
|
|
|
|
|
Para aplicar a migração no banco, rode:
|
|
|
```shell
|
|
|
db-upgrade
|
|
|
```
|
|
|
|
|
|
Para desfazer uma migração, rode:
|
|
|
```shell
|
|
|
db-downgrade
|
|
|
```
|
|
|
|
|
|
---
|
|
|
|
|
|
## 📜 Documentation
|
|
|
|
|
|
TBD
|
|
|
|
|
|
---
|
|
|
|
|
|
## 👌🏼 Deploy
|
|
|
|
|
|
TBD
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<br />
|
|
|
<div align="center">
|
|
|
|
|
|
<!-- <a href="">
|
|
|
<img src="" alt="Decola" width="150">
|
|
|
</a> -->
|
|
|
|
|
|
<h3 align="center">Configuração FRONTEND</h3>
|
|
|
|
|
|
<p align="center">
|
|
|
Backend do projeto Decola desenvolvido na AGES no segundo semestre de 2024.
|
|
|
<br /> |