https://github.com/jvictorfarias/community
https://github.com/jvictorfarias/community
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jvictorfarias/community
- Owner: jvictorfarias
- License: mit
- Created: 2020-08-08T03:02:07.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T20:52:34.000Z (almost 3 years ago)
- Last Synced: 2025-01-20T07:43:40.451Z (10 months ago)
- Language: TypeScript
- Size: 1.25 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Community
[](http://github.com/jvictorfarias/community/LICENSE.md)
[](https://www.codacy.com/manual/jvictorfarias/community_2?utm_source=github.com&utm_medium=referral&utm_content=jvictorfarias/community&utm_campaign=Badge_Grade)
:fire: Prévia da Aplicação |
:rocket: Tecnologias Usadas |
:hammer: Deploy da Aplicação |
:thinking: Como Contribuir? |
:zap: Executando o Projeto
## :rocket: 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:
- [NodeJS](https://nodejs.org/en/)
- [ExpressJS](https://expressjs.com/pt-br/)
- [JWT](https://jwt.io/)
{...}
## :hammer: Deploy da Aplicação
[Heroku](https://cryptic-brook-95865.herokuapp.com/)
## :thinking: Como Contribuir?
**Faça um fork deste repositório**
```bash
# 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.
## :zap: Executando o Projeto
#### Clonando o projeto
```sh
$ git clone https://github.com/jvictorfarias/community.git
$ cd community
```
#### Iniciando a API
```sh
$ 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
```
[](https://insomnia.rest/run/?label=Community&uri=https%3A%2F%2Fdrive.google.com%2Ffile%2Fd%2F1XuDjZbQt1hsVtRQ5fA-xMnnmJaMqIKhw%2Fview%3Fusp%3Dsharing)
### :memo: Licença
Este projeto é desenvolvido sob a licença MIT. Veja o arquivo [LICENSE](LICENSE.md) para saber mais detalhes.
Feito com :purple_heart: by Joao Victor Farias