Alfred Code/Station Hackathon 2021

📕 Índice

• 📋 Sobre
• 🕹 Tecnologias
• 🧑🏽‍💻 Iniciando o projeto
• 👨🏽‍🔧 Contribuições
• 📝 Licença
• 🦸 Contatos

---

Sobre

Aplicação desenvolvida durante Hackathon Code/Station 2021, Alfred foi feito com o intuito de melhorar a qualidade de vida de condôminos e também das portarias dos respectivos condomínios, de modo que, o condômino possa mandar uma simples mensagem de WhatsApp para avisar algo para a portaria ou vice versa, como por exemplo, avisar antecipadamente que fez um Delivery de modo que facilite a entrada do entregador e seja mais rápido a entrega.

Tecnologias

• Tecnologias
  • Node JS
    • TypeScript
  • Express
  • TypeORM
    • PostgresSQL
  • FireORM
    • Firestore
• Dependências
  • Babel
  • Eslint
  • Jest
  • Reflect-metadata
  • Tsyringe

---

Iniciando

Pré-requisitos

• Node JS

  https://nodejs.org/en/

• Yarn ou Npm

  https://yarnpkg.com/

• PostgresSQL

  https://www.postgresql.org/

---

Instalação e uso

# Execute este comando para clonar o projeto
$ git clone https://github.com/jorge-lba/hack-ignite-backend.git
# ou use a opção de download.

# Entre na pasta com
$ cd hack-ignite-backend

# Instale as dependências
$ yarn ou npm install

# Crie o banco de dados e as tabelas utilizando o comando
$ yarn typeorm migration:run

# Rode a aplicação usando o comando
$ yarn dev

Contribuições

1. Faça um Fork do projeto
2. Crie uma Branch para sua Feature (git checkout -b feature/FeatureIncrivel)
3. Adicione suas mudanças (git add .)
4. Comite suas mudanças (git commit -m 'Adicionando uma Feature incrível!)
5. Faça o Push da Branch (git push origin feature/FeatureIncrivel)
6. Abra uma Pull Request

Licença

Distribuído sob a licença MIT. Veja LICENSE para mais informações.

Contatos

@jorge-lba	@LevyAM	@WelissonLuca