Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thallyta-castro-cv/bookstore-api
Este projeto é uma API para gerenciamento de uma livraria, desenvolvida com Node.js. A API permite o cadastro, atualização, exclusão e consulta de livros, além de gerenciar autores. O objetivo é servir como base para projetos de APIs RESTful com boas práticas, fácil manutenção e escalabilidade.
https://github.com/thallyta-castro-cv/bookstore-api
javascript mongodb mongoose nodejs
Last synced: about 1 month ago
JSON representation
Este projeto é uma API para gerenciamento de uma livraria, desenvolvida com Node.js. A API permite o cadastro, atualização, exclusão e consulta de livros, além de gerenciar autores. O objetivo é servir como base para projetos de APIs RESTful com boas práticas, fácil manutenção e escalabilidade.
- Host: GitHub
- URL: https://github.com/thallyta-castro-cv/bookstore-api
- Owner: thallyta-castro-cv
- Created: 2024-10-02T17:24:21.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-11-07T14:24:05.000Z (about 2 months ago)
- Last Synced: 2024-11-07T15:31:08.326Z (about 2 months ago)
- Topics: javascript, mongodb, mongoose, nodejs
- Language: JavaScript
- Homepage:
- Size: 152 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Livraria API com Node.js
Projeto em Andamento!
Este projeto foi criado usando Node 20.15.0
## Sobre o Projeto
Este projeto é uma API para gerenciamento de uma livraria, desenvolvida com Node.js. A API permite o cadastro, atualização, exclusão e consulta de livros, além de gerenciar autores.
O objetivo é servir como base para projetos de APIs RESTful com boas práticas, fácil manutenção e escalabilidade.
### Funcionalidades Principais
- Gerenciamento de livros (CRUD: criar, ler, atualizar e deletar).
- Gerenciamento de autores.
- Integração com banco de dados MongoDB para persistência dos dados.
## Tecnologias Utilizadas
- **Node.js**: Ambiente de execução para JavaScript no servidor.
- **Express**: Framework web para criação de rotas e gerenciamento da API.
- **MongoDB**: Banco de dados NoSQL utilizado para armazenar informações sobre livros, autores e categorias.
- **Mongoose**: ODM (Object Data Modeling) para interação com o MongoDB.
- **Dotenv**: Gerenciamento de variáveis de ambiente, como chaves secretas e URLs de banco de dados.
- **Nodemon**: Ferramenta de desenvolvimento que reinicia automaticamente o servidor quando alterações são detectadas.
- **Swagger**: Biblioteca Open Api 3 que gera a documentação dos endpoints do projeto.
# Iniciando o projeto
Para iniciar a aplicação execute a seguinte ação na pasta raiz
Instale as dependências do npm com o comando:
```shell script
npm install
```
Para iniciar a aplicação execute a seguinte ação na pasta raiz
```shell script
npm run dev
```
Consultar documentação da Api:
```shell script
http://localhost:3000/api-docs
```
## Autor
Thallyta Macedo Carvalho de Castro
Linkedin: https://www.linkedin.com/in/thallyta-castro/
Medium: https://medium.com/@thallyta-castro-cv
email: [email protected]