Api Restful de cadastro de posts, atraves dessa api e possivel cadastra , atualizar e excluir post, categoria e usuario. A conexão com o banco de dados foi feita com o ORM Sequelize e a autenticação com Json Web Token.
Technologies that I used to develop this web client
🐋 Rodando no Docker vs Localmente
1.26.0
por 1.29.2
.
ℹ️ Rode os serviços
node
edb
com o comandodocker-compose up -d --build
.
-
Lembre-se de parar o
mysql
se estiver usando localmente na porta padrão (3306
), ou adapte, caso queria fazer uso da aplicação em containers; -
Esses serviços irão inicializar um container chamado
blogs_api
e outro chamadoblogs_api_db
; -
A partir daqui você pode rodar o container
blogs_api
via CLI ou abri-lo no VS Code;
ℹ️ Use o comando
docker exec -it blogs_api bash
.
- Ele te dará acesso ao terminal interativo do container criado pelo compose, que está rodando em segundo plano.
ℹ️ Instale as dependências [Caso existam] com
npm install
. (Instale dentro do container)
-
⚠️ Atenção: Caso opte por utilizar o Docker, TODOS os comandos disponíveis nopackage.json
(npm start, npm test, npm run dev, ...) devem ser executados DENTRO do container, ou seja, no terminal que aparece após a execução do comandodocker exec
citado acima. -
⚠️ Atenção: O git dentro do container não vem configurado com suas credenciais. Ou faça os commits fora do container, ou configure as suas credenciais do git dentro do container. -
⚠️ Atenção: Não rode o comando npm audit fix! Ele atualiza várias dependências do projeto, e essa atualização gera conflitos com o avaliador. -
✨ Dica: A extensão
Remote - Containers
(que estará na seção de extensões recomendadas do VS Code) é indicada para que você possa desenvolver sua aplicação no container Docker direto no VS Code, como você faz com seus arquivos locais.
ℹ️ Instale as dependências [Caso existam] com
npm install
-
⚠️ Atenção: Não rode o comando npm audit fix! Ele atualiza várias dependências do projeto, e essa atualização gera conflitos com o avaliador. -
✨ Dica: Para rodar o projeto desta forma, obrigatoriamente você deve ter o
node
instalado em seu computador. -
✨ Dica: O avaliador espera que a versão do
node
utilizada seja a 16.
Clone the project and access the folder
$ git clone https://github.com/ganimedes96/BlogAPI && cd BlogAPI
Follow the steps below to install the required dependencies
# Install the dependencies
$ npm install
# Be sure the file 'src/services/api.ts' have the IP to your API
# Start the client
$ npm run debug
# O servidor inciará na porta:3333 - acesse http://localhost:3000
follow the steps below to clone the repository on your machine
# Clone your fork
$ git clone your-fork-url && cd BlogAPI
# Create a branch with your feature
$ git checkout -b feature
# Make the commit with your changes
$ git commit -m 'First Commit'
# Send the code to your remote branch
$ git push origin my-feature
After your pull request is merged, you can delete your branch