A Shopify Integration API é uma API desenvolvida para facilitar a integração e o gerenciamento de produtos em uma loja Shopify. Esta API fornece uma interface para realizar operações CRUD (Create, Read, Update, Delete) nos produtos da loja, aproveitando as capacidades da Shopify API.
- Gerenciamento de Produtos: Adicione, atualize e remova produtos da sua loja Shopify.
- Consulta de Produtos: Recupere detalhes dos produtos.
- Integração com Shopify API: Conecte-se diretamente à Shopify para realizar operações na loja.
- Node.js: Plataforma para executar a aplicação.
- Express: Framework para construção da API.
- Prisma: ORM para interação com o banco de dados.
- Shopify API: Biblioteca para integração com a Shopify.
- Swagger: Documentação da API.
- Jest: Testes automatizados.
Para instalar e executar a aplicação, siga os passos abaixo:
-
Clone o repositório:
git clone https://github.com/brendamatias/shopify-api cd shopify-api
-
Instale as dependências:
Certifique-se de ter o Node.js e o npm instalados. Depois, execute:
npm install
-
Configure as variáveis de ambiente:
- Copie o arquivo
.env.example
para.env
e ajuste as variáveis conforme necessário.cp .env.example .env
- Edite o arquivo
.env
para incluir suas configurações específicas.
- Copie o arquivo
-
Configure o banco de dados:
- Certifique-se de que o banco de dados está configurado corretamente e acessível.
-
Execute as migrações (se aplicável):
npx prisma migrate deploy
-
Inicie a aplicação:
npm start
-
Certifique-se de ter o Docker e o Docker Compose instalados.
-
Configure as variáveis de ambiente:
- Copie o arquivo
.env.example
para.env
e ajuste as variáveis conforme necessário.cp .env.example .env
- Edite o arquivo
.env
para incluir suas configurações específicas.
- Copie o arquivo
-
Inicie os serviços com Docker Compose:
docker-compose up db -d docker-compose up app
Isso criará e iniciará os containers definidos no seu
docker-compose.yml
. -
Para parar os serviços:
docker-compose down
Para executar os testes automatizados, utilize:
docker-compose up db_test -d
npm test
A API é documentada com Swagger e pode ser acessada em:
http://localhost:3333/docs