Community

🔥 Prévia da Aplicação | 🚀 Tecnologias Usadas | 🔨 Deploy da Aplicação | 🤔 Como Contribuir? | ⚡ Executando o Projeto

🚀 O projeto

Aplicação para gerenciar famílias e indivíduos de comunidades, auxiliando o trabalho de ACSs.

:Fire: Tecnologias Usadas

O projeto foi feito com as seguintes tecnologias:

🔨 Deploy da Aplicação

Heroku

🤔 Como Contribuir?

Faça um fork deste repositório

# Clone o seu fork
$ git clone url-do-seu-fork && cd community

# Crie uma branch com sua feature ou correção de bugs
$ git checkout -b minha-branch

# Faça o commit das suas alterações
$ git commit -m 'feature/bugfix: minhas alterações'

# Faça o push para a sua branch
$ git push origin minha-branch

Depois que o merge da sua pull request for feito, você pode deletar a sua branch.

⚡ Executando o Projeto

Clonando o projeto

$ git clone https://github.com/jvictorfarias/community.git
$ cd community

Iniciando a API

$ cd src
# Tenha certeza que possui o NodeJS e Yarn instalados
$ yarn install
# Criando a imagem Docker do banco de dados:
# Dentro do projeto, já existe uma arquivo docker-compose.yml que possui o
# PostgreSQL como banco de dados, basta ter o Docker instalado em sua máquina.
$ docker-compose up -d # Iniciará em background e não irá bloquear o shell
# *CONFIGURE UM ARQUIVO .ENV, COM SUAS ENTRADAS IGUAL A .ENV.EXAMPLE
# Rodando as migrations para o banco de dados e iniciando o projeto
$ yarn typeorm migration:run && yarn dev:server

📝 Licença

Este projeto é desenvolvido sob a licença MIT. Veja o arquivo LICENSE para saber mais detalhes.

Feito com 💜 by Joao Victor Farias

jvictorfarias / community