Projeto Happy

Levando felicidade para o mundo

⚠️ Atenção: Essa é apenas o back-end do projeto, você pode encontrar as outras partes aqui.


📱 Mobile
💻 Web
🌐 Back-end

Sumário

• Sobre o projeto
• Tecnologias
• Iniciando
• Documentação
• Contribuições
• Licença
• Contato

Sobre o projeto

💡 Projeto idealizado para a divulgação de orfanatos locais por meio de cadastro.

Tecnologias Usadas

Essas foram as tecnologias mais utilizados no decorrer do projeto

• Typescript
• Postgres
• Typeorm

Iniciando

Para rodar o projeto localmente você precisará seguir algumas intruções

Pré-requisitos

• É necessário que o NodeJS esteja instalado em sua máquina
• Você também irá precisar de um gerenciador de pacotes, nesse projeto usei o Yarn
• Foi usado Postgres nesse projeto, vá ao arquivo ormconfig.js e insira as informações de sua conexão.

Instalação

# Clone o repositório
git clone https://github.com/cKauan/happy-server.git
# Instale todos os pacotes
# Yarn
yarn install
# Npm
npm install
# Rode as migrations
# Yarn
yarn typeorm migration:run
# Npm
npm run typeorm migration:run
# Ambiente de desenvolvimento
# Yarn
yarn dev
# Npm
npm run dev
# Ambiente de Produção
# Yarn
yarn build
# Npm
npm run build
# Iniciar em produção
# Yarn
yarn start
# Npm
npm run start

Documentação

// Criar orfanatos
POST - /orphanages
Content-Type: multipart/form-data
name: string*
latitude: number*
longitude: number*
about: string*
instructions: string*
opening_hours: string*
open_on_weekends: boolean*
images: file*
*: Obrigatório
// Listar orfanatos
GET - /orphanages
[
  {
    id: number,
    name: string,
    latitude: number,
    longitude: number,
    about: string,
    instructions: string,
    opening_hours: string,
    open_on_weekends: boolean,
    images: [
      {
        id: number,
        url: string
      }
    ]
  }
]
// Detalhes de um orfanato
GET - /orphanages/:id
{
  id: number,
  name: string,
  latitude: number,
  longitude: number,
  about: string,
  instructions: string,
  opening_hours: string,
  open_on_weekends: boolean,
  images: [
    {
      id: number,
      url: string
    }
  ]
}
// Deletar um orfanato
DELETE - /orphanages/:id
{
  message: "Sucess Deleted"
}

Contribuições

Você quer contribuir para o projeto e não sabe como?

1. Dê Fork no projeto
2. Crie uma branch para sua feature (git checkout -b feature/AmazingFeature)
3. Comite as alterações (git commit -m 'Add some AmazingFeature')
4. Faça o push para a branch (git push origin feature/AmazingFeature)
5. Abra um Pull Request

Licença

MIT

Contato

Carlos Kauãn - https://twitter.com/carlaodamassaa - carloskauanmoreiradesousa@gmail.com

Link do projeto: https://github.com/cKauan/happy-web

Feito com 💚 por Carlos Kauãn