Giter VIP home page Giter VIP logo

alertarecifeback-end's Introduction

API REST Alerta Recife

API Rest simples construida com Typescript, Node.js,Express, Prisma e SQLite

Instalação

Como rodar o projeto na sua máquina

1. Clone o repositório.

  git clone https://github.com/sergiohdljr/AlertaRecifeBack-end.git

2. Instale as dependências

  cd AlertaRecifeBack-end/
  npm install

3. Iniciando o Servidor

  npm run dev

o servidor agora vai estar rodando na porta http://localhost:3000

Usando a API

Você pode acessar a API do servidor usando os seguintes endpoints:

GET

  • /ocorrencias: Retorna todas as ocorrencias registradas e os usuários que cadastraram tal ocorrencia.

  • /ocorrencias/:email: Retorna apenas as ocorrencias registradas pelo usuário

    • Params:
      • email: String (required): e-mail do usuário que você deseja obter as ocorrencias.

POST

  • /ocorrencia: Registra uma nova ocorrencia.
    • Body:

      • fotoDaOcorrencia: Bytes (Opcional):Foto do momento da ocorrencia
      • TipoDaOcorrencia: String (required):Tipo de ocorrencia ex: roubo, batida de carro..
      • descricaoDaOcorrencia: String (required):Descrição da ocorrencia que deseja registrar
      • latitude: Decimal (required):Latitude em tempo real de onde ocorreu aproximadamente a ocorrencia.
      • longitude: Decimal (required):Longitude em tempo real de onde ocorreu aproximadamente a ocorrencia
      • nome: String (required): Nome do usuário.
      • email: String (required): Email do usuário.
      • fotoPerfil: String (required): URL da foto do perfil do usuário.

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.