https://github.com/odevthomas/doker
Uma API RESTful escalável utilizando Node.js, Express e PostgreSQL, containerizada com Docker.
https://github.com/odevthomas/doker
Last synced: 4 months ago
JSON representation
Uma API RESTful escalável utilizando Node.js, Express e PostgreSQL, containerizada com Docker.
- Host: GitHub
- URL: https://github.com/odevthomas/doker
- Owner: odevthomas
- Created: 2025-03-22T00:54:29.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-03-22T01:12:41.000Z (11 months ago)
- Last Synced: 2025-03-22T02:21:48.261Z (11 months ago)
- Language: JavaScript
- Homepage:
- Size: 5.62 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
API Node.js com Docker e PostgreSQL
Uma API RESTful escalável utilizando Node.js, Express e PostgreSQL, containerizada com Docker.
Funcionalidades •
Tecnologias •
Como Usar •
Instalação •
Estrutura •
Licença
---
## ⚙️ Funcionalidades
- **CRUD de Usuários**: Criar, ler, atualizar e deletar usuários.
- **Banco de Dados PostgreSQL**: Uso do Sequelize como ORM.
- **Containerização**: Configuração com Docker e Docker Compose.
- **Roteamento com Express**: Estrutura modular e escalável.
- **Variáveis de Ambiente**: Configuração via `.env`.
---
## 🚀 Tecnologias
Este projeto utiliza as seguintes tecnologias:
- [Node.js](https://nodejs.org/) - Plataforma JavaScript para backend.
- [Express](https://expressjs.com/) - Framework web para Node.js.
- [PostgreSQL](https://www.postgresql.org/) - Banco de dados relacional.
- [Sequelize](https://sequelize.org/) - ORM para PostgreSQL.
- [Docker](https://www.docker.com/) - Containerização.
- [Postman](https://www.postman.com/) - Teste da API.
---
## 🛠️ Como Usar
1. Clone o repositório:
```bash
git clone https://github.com/seu-usuario/seu-repo.git
cd seu-repo
```
2. Crie um arquivo `.env` e configure:
```env
DB_USER=postgres
DB_PASSWORD=postgres
DB_NAME=meubanco
DB_HOST=meu-banco
PORT=3000
```
3. Execute com Docker Compose:
```bash
docker-compose up --build
```
A API estará disponível em `http://localhost:3000`.
---
## 📂 Estrutura
```
/src
/controllers
userController.js
/models
User.js
index.js
/routes
userRoutes.js
/config
database.js
server.js
Dockerfile
docker-compose.yml
package.json
.env
```
---
## 📝 Licença
Este projeto está licenciado sob a MIT License. Veja o arquivo [LICENSE](LICENSE) para mais detalhes.
---
Desenvolvido por Thomas Eduardo