Skip to content

caiogmrocha/happy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🚧 ... Em Construção ... 🚧

GitHub Language Count GitHub Repository Size GitHub Contributors GitHub Last Commit GitHub License GitHub Stars

💻 Sobre o Projeto

👧👦 Happy: é um site que facilita o encontro de orfanatos para marcação de visitas ou consulta.

:atom: Ferramentas

:atom: Bibliotecas Usadas

  • Leaflet/React Leaflet (Biblioteca de mapas para a Web)

  • Express (Construção de aplicações Web e API's)

  • TypeORM (Fornece recursos relacionados a Banco de Dados)

  • Yup (Validação de dados)

  • CORS (Permite que outras aplicações possam acessar a API)

  • Multer (Upload de Arquivos)

🚀 Começando

Neste tópico você irá encontrar as instruções para iniciar o projeto da maneira correta.

Primeiro clone este projeto usando os seguintes comandos no Terminal:

# Clone este repositório
$ git clone https://github.com/CaioGui123/Happy.git

🎲 Configurando Backend

Entre no diretório do Backend da aplicação com cd backend.

Agora vamos instalar as dependências:

# Instalando as dependências
$ yarn install

ou

# Instalando as dependências
$ npm install

Execute as Migrações:

# Rodando as Migrations
$ yarn typeorm migration:run

ou

# Rodando as Migrations
$ npm run typeorm migration:run

Crie um diretório chamado 'uploads' na raiz do projeto:

# Criando diretório
$ mkdir uploads

Inicie o Servidor:

# Iniciando o Servidor
$ yarn dev

ou

# Iniciando o Servidor
$ npm run dev

Com isso você podera acessar a API pela rota: (http://localhost:3333)

🧭 Configurando Frontend

Entre no diretório do Frontend da aplicação com cd web.

Agora vamos baixar o React e outras dependências:

# Instalando as dependências
$ npm install

ou

# Instalando as dependências
$ yarn install

Agora você poderá acessar o site pela rota: (http://localhost:3000)

📝 Licença

Este projeto esta sobe a licença MIT.

Feito com 💜 👋