Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mairess/project-talker-manager
Talker Manager é uma API para cadastro de palestrantes, com todas as rotas documentas com swagger-ui, onde é possível fazer um CRUD. Usei banco de dados em memória e MySQL.
https://github.com/mairess/project-talker-manager
docker expressjs javascript mysql2 nodejs sql swagger-ui
Last synced: 3 days ago
JSON representation
Talker Manager é uma API para cadastro de palestrantes, com todas as rotas documentas com swagger-ui, onde é possível fazer um CRUD. Usei banco de dados em memória e MySQL.
- Host: GitHub
- URL: https://github.com/mairess/project-talker-manager
- Owner: mairess
- Created: 2023-12-13T22:30:48.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-13T22:01:45.000Z (10 months ago)
- Last Synced: 2024-04-14T12:13:10.894Z (10 months ago)
- Topics: docker, expressjs, javascript, mysql2, nodejs, sql, swagger-ui
- Language: JavaScript
- Homepage:
- Size: 312 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
#
Projeto Talker Manager
## Contexto
Este projeto consiste em uma `API REST` `Node` com `Express` para cadastro de palestrantes. Sendo possível cadastrar, visualizar, pesquisar, editar e excluir os dados, implementando um CRUD, utilizando um banco em memória e uma das rotas utilizando o `MySQL` para armazenamento.
Rode o projeto localmente
> ⚠️ É preciso ter o [Node](https://nodejs.org/en) instalado em sua máquina.
>
> ⚠️ É preciso criar um arquivo `.env` na raiz do projeto, siga o exemplo do arquivo [`env.example`](./env.example).
>
1. Clone o repositório:
```BASH
git clone [email protected]:mairess/project-talker-manager.git
```
2. Instale as dependências:
```BASH
npm install
```
3. Inicie server:
```BASH
env $(cat .env) npm run dev
```
Rode o projeto com o docker
> ⚠️ É preciso ter o [Docker](https://www.docker.com/get-started/) instalado em sua máquina.
1. Clone o repositório:
```BASH
git clone [email protected]:mairess/project-talker-manager.git
```
2. Suba os containers:
```BASH
docker compose up -d
```
3. Acesse o terminal do container:
```BASH
docker exec -it talker_manager bash
```
4. Inicie o server, estará disponível na porta `3001`:
```HTML
npm run dev
```
## Documentação da API
A documentação desta api está disponível em `/api-docs`
## Tecnologias utilizadas
- Javascript
- Node
- Express
- MySQL
- Docker
- Swagger-ui