barber-shop-api

Descrição do Projeto

Este projeto está repartida em duas partes uma ainda não se começou dar inicio está em stand by que é o app mobile, e essa parte que é backend que tem como finalidade de trabalhar em toda a regra de negocio, se conectar com serviços externo(pagamento, notificações, mensagem), a base de dados, libs entre outros mais. Usando melhor práticas de programação como: BDD, TDD, Arquitetura limpa, CI/CD, SOLID, design patterns, git entre outros, tendo a linguagem javascript para sua implementação em apoio com seu superSet o typescript, nodejs, express, entre outros mais recursos. Para gerencia das tarefas ou as atividades está se utilizando notion que tem-se encaixado como uma luva.

Sobre este projeto

Esse projeto surgiu devido em consequência de um app mobile que eu queria desenvolver que com react-native (barber-shop) que tem como objetivo ajudar o cliente da barbearia que quisessem marcar um dia e hora na semana, no primordios das implementação já sentia que necessitava de um backend ou API para as regras de negocios, visto que o firebase só fornece o serviço de armazenamento e eu não queria a minha regra de negocios estivesse no meu app por causa caso quisesse implementar o projeto futuramente na web não me desse tanto trabalho então vee que a API seria a melhor opção. Mas também pelo gostinho de desenvolver o backend que é a parte de desenvolvimento que mais se encaixa comigo mesmo não tanto amando ela.

Links

• Documentação da api. Nota:lembrando que o servidor deve estar rodando
• Notion
• API-HOSPEDADA

🚧A Barber-Shop(API) 🚀 Em construção... 🚧

Indices

• Descrisão do projeto
• Features
• Começando a usar
• Tecnologia usada
• Executando testes
• Autores
• Licença
• Expressões de gratidão

🔨 Features

Aqui temos as rotas desenvolvidas nesse projeto:

• feat: signUp
• feat: login
• feat: buscar todos os servicos

Acessa API por esta url : https://barber-shop-api.onrender.com/api/

🚀 Começando a usar

Para que esse projeto possa funcionar na sua máquina deve-se cumprir os seguintes requisitos e depois seguir passo a passo como instalar o projeto.

📋 Pré-requisitos

Para se ter esse projeto a funcionar deve se ter o Nodejs na sua maquina que vai permitir com que projeto rode na sua maquina, Git, conseguir clonar o projeto na sua máquina, Vscode.

🔧 instalação do projeto

 # Primeiro clonar o projeto
    git clone <URL>

 # Acender a pasta
    cd barber-shop-api

 # instalar as dependencias do projeto
    npm install

 # Rodar aplicativo
    npm start:dev

 # Depois scanner o QRcode ou uri para ver o projeto a funcionar

⚙️ Executando os testes

Para rodar os testes basta seguir os passos descritos em baixo:

 # Esse comando permite rodar todos os testes tanto de integração como de unidade
    npm test

 # Esse comando permite rodar teste que em arquivos que mudando
    npm run test:watch

 # Esse comando permite rodar todos teste e mostra o coverage no final
    npm run test:ci

Para poder ver a documentação

Para rodar os testes basta seguir os passos descritos em baixo:

 # Esse comando permite rodar todos os testes tanto de integração como de unidade
    npm run start:dev
 # copia o link: 
 http://localhost:5555/api-docs

🛠️ Tecnologia usada

Durante as bibliotecas que estão sendo usada para desenvolvimento desta api:

Dependencia de desenvolvimento

• prisma
• jest
• eslint
• husky
• typescript
• lint-staged
• rimraf
• semantic-release
• supertest
• tsx
• prisma
• git-commit-msg-linter
• dotenv

Dependencia de produção

• module-alias
• express
• bcrypt
• jwt
• zod
• @prisma/client

✒️ Autores

Projeto desenvolvido por Walany da Costa.

📄 Licença

Este projeto está sob a licença MIT licença.

🎁 Expressões de gratidão

Convidou Todas a gente que gostou desse projeto tanto nos aspeto de tecnologia ou a ideias do projeto para contribuir esse projeto afim de dar passo maior.