This is a Brazilian Project. So, the content here will be explained in Portuguese. An English version will be released soon for those who want to use its structure.
Carnê Fácil was created to generate payment books. You can use its source code to create any other functionality that you might like.
#Seja Bem-vindo ao Carnê Fácil!
###O que é?
Carnê Fácil é um projeto Open-Source, desenvolvido inteiramente em JavaScript. Utilizando a arquitetura MEAN (MongoDB, Express.js, Angular.js e Node.js), o projeto tem como objetivo realizar um controle de clientes, geração e pagamento de carnês de prestações.
###Para que projetos posso utilizá-lo?
O Carnê fácil ainda está nos seus primórdios de desenvolvimento, mas caso você tenha um projeto similar, ele estará disponível para que você utilize todo o código implementado aqui e que faça suas próprias mudanças customizadas. Caso você também esteja aberto a colaborar com uma iniciativa OpenSource, você poderá ser um colaborador, para que outras pessoas também o utilizem e possam melhora-lo.
###Execução
Caso você queira executar a aplicação, são necessários alguns pré-requisitos. São eles:
Após essas dependencias serem instaladas, você precisará de alguns pacotes do Node. São eles:
- bower (para instalar os sub-pacotes)
npm install -g bower
- grunt (para execução)
npm install -g grunt-cli
####Instalação:
Primeiro será necessário clonar o repositório do git. Nesse caso:
git clone https://github.com/andredeloliveira/carnefacil.git carnefacil && cd carnefacil
Para instalação rápida:
npm install
####Execução:
Para executar,
grunt
###Licença
Este software possui licença MIT
###Atualizações
O software sofrerá multiplas atualizações. Para mais informações siga, dê um fork ou star na minha conta do GitHub.