GithubHelp home page GithubHelp logo

findafriend-api's Introduction

🚀 Tecnologias

Esse projeto está utilizando as seguintes tecnologias:

📜 Descrição

Esse projeto consiste em uma API para uma aplicação de adoção de animais, nele foi utilizado padrões de arquitetura de software e foram desenvolvidos testes unitários e E2E.

⚙️ Como funciona?

RFs (Requisitos funcionais)

  • É possível cadastrar um pet
  • É possível listar todos os pets disponíveis para adoção em uma cidade
  • É possível filtrar pets por suas características
  • É possível visualizar detalhes de um pet para adoção
  • É possível deletar um pet
  • É possível se cadastrar
  • É possível realizar login
  • É possível realizar login com github
  • É possível se cadastrar como uma ORG
  • É possível realizar login como uma ORG

RNs (Regras de negócio)

  • Para listar os pets, obrigatoriamente precisamos informar a cidade
  • Uma ORG precisa ter um endereço e um número de WhatsApp
  • Um pet deve estar ligado a uma ORG
  • Todos os filtros, além da cidade, são opcionais

🎲 Como usar o projeto?

Clone esse repositório

git clone https://github.com/tilo1306/FindAFriend-API.git

Navegue até o diretório do projeto

cd FindAFriend-API

Execute atravez do docker

docker compose up -d

Acessar ao swagger

http://localhost:3333/docs/static/index.html

findafriend-api's People

Contributors

tilo1306 avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.