/rcstore_backend

API em NodeJS de produtos

Primary LanguageTypeScript

Backend para a aplicação RC Store

Backend para aplicação RC Store (CRUD de produtos)

Status

GitHub top language GitHub language count GitHub code size in bytes GitHub last commit

Projeto contruído com conhecimentos em Node.js e Typescript.

📝 Tabela de conteúdos

🧐 Sobre

API e banco de dados para a aplicação RC Store (CRUD de produtos). A aplicação é um modelos de CRUD de produtos para loja virtual (E-Commerce).

Aplicação voltada à criação de produtos, listagem, edição e remoção. Simbolozando um uso comum em gerenciamento de lojas virtuais em produtos e estoque. A aplicação conta com principais recursos e bibliotecas em seu desenvolvimento.

A API está documentada, nesse link.

Criado com requisitos baseados no teste da JET E-commerce.

🏁 Iniciando

Rotas da Aplicação

  • POST /products: Rota para cadastrar um novo produto. O corpo da requisição deve conter as informações da do produto a ser cadastrado, sem o ID (gerado automaticamente pelo servidor).

  • GET /products: Rota para listar todos os produtos.

  • DELETE /products/{id}: Rota para deletar um produto específico.

  • PUT /products/{id}: Rota para editar um produto.

Como contribuir?

Você pode utilizar esse projeto, para fornecer dados e cadastrar para uma aplicação Front-End desenvolvida em qualquer plataforma, como Angular, ReactJS, VueJS, etc.

Requisitos

Ter instalado pelo menos um gerenciador de pacotes do Node, Npm ou Yarn.

Installing

Executar na raiz do projeto o seguinte comando para instalar as dependências yarn install ou npm install

Para executar a API localmente, deve ter um container com Postgress com o nome correto para que o typeorm possa se conectar ao seu banco de dados.

Obs: Usar exemplo de arquivo '.env' com as configurações de banco de dados que estão em um arquivo no diretório principal do projeto com o nome ".env.exemple".

🎈 Uso

yarn dev

⛏️ Construído utilizando

Bibliotecas/Frameworks

✍️ Author

👤 Roberlan Carvalho