backend

Índice

• Sobre
• Tecnologias utilizadas
• Como fazer o download do projeto
• Como executar o projeto

🧾 Sobre

Esta é uma API REST para:

• Listar os orfanatos criados

  # GET
  /orphanages

• Visualizar os dados de um determinado orfanato que já tenha sido cadastrado na plataforma

  # GET
  /orphanages/:id

• Cadastrar orfanatos na aplicação

  # POST
  /orphanages

🚀 Tecnologias utilizadas

Este projeto Front-end foi desenvolvido utilizando as seguintes tecnologias:

• Typescript
• NodeJS
• Express
• Multer
• SQLite
• TypeORM
• Yup

Veja todas as dependências do projeto abrindo o arquivo package.json

🔽 Como fazer o download do projeto

1. Execute no terminal:
   

   $ git clone https://github.com/victorbadaro/happy.git

   Este comando acima fará o download do projeto completo: API e Front-end (WEB e App Mobile)

💻 Como executar o projeto

Siga os passos abaixo para executar este projeto Back-end:

1. Entre no diretório do projeto

   $ cd happy
   $ cd backend

2. Instale as dependências do projeto
   usando Yarn

   $ yarn install

   Ou, se você estiver usando o NPM

   $ npm install

3. Enfim, execute o projeto
   com Yarn

   $ yarn dev

   com NPM

   $ npm run dev

A aplicação será aberta por padrão em:
http://localhost:3333

✅ Pronto! Se você seguiu corretamente os passos acima o projeto ja estará sendo executado localmente em tua máquina.

---

Desenvolvido com ❤ por Victor Badaró