Api contendo as lógicas de negócio do gerenciador financeiro que pretende transformar os usuários em poupadores e aplicadores.
Estas instruções irão te fornecer uma cópia do projeto instalado e rodando no seu ambiente local com propósitos de desenvolvimento e testes.
Os seguintes softwares devem estar instalados e configurados para que seja possível executar o projeto:
- Git
- MongoDB v3.4.3
- Redis v3.2.9
- Ruby v2.4.1
Orientações para a instação dos softwares listados acima podem ser encontrados nos seus respectivos websites
Estando todos os pré requisitos instalados e configurados passaremos para a instalação do projeto.
Faça o clone do repositório do projeto:
git clone https://github.com/praser/enriquece.me-backend
Instale a Gem Bundler para baixar as dependências do projeto
gem install bundler
Acesse a pasta onde o repositório foi clonado
cd enriquece.me-backend/
Instale as dependências
bundle install
Altere o arquivo config/mongoid.yml conforme a configuração local da sua instalação do MongoDB
Semeie o banco de dados executando o comando abaixo
rake db:seed
Pronto! Agora você deve ter uma cópia funcional do backend rodando na sua máquina local.
Inicie o servidor e faça algumas requisições:
rails s
Para testar se tudo está funcionando corretamente, tente cadastrar um novo usuário:
curl -H "Content-Type: application/json" -X POST -d '{"name": "John Doe", email":"johndoe@exemple.com","password":"senha-marota"}' http://localhost:3000/users
Este sistema é construído seguindo a técnica do TDD (Test Driven Development) ou desenvolvimento guiado por testes. Para tal utilizamos o RSpec para automatização de testes.
Para executar a suíte de testes funcionais, execute o comando abaixo no console:
rake spec
Atualmente o backend ainda não está em produção. A versão de desenvolvimento está hospedada no Heroku e pode ser acessada através do endereço http://api.enriquece.me
- MongoDB - For GIANT ideas
- Rails - A web-application framework that includes everything needed to create database-backed web applications according to the Model-View-Controller (MVC) pattern.
- Redis - Redis is an open source (BSD licensed), in-memory data structure store, used as a database, cache and message broker.
- Ruby - O melhor amigo do programador
Por favor leia CONTRIBUTING.md (em inglês) para detalhes sobre a nossa conduta de codificação, e o processo de submeter pull requests para nós.
Nós utilizamos SemVer para versionamneto. Para listar as versões disponíveis veja as tags deste repositório.
- Breno Sales - Programação - brenosales
- Eduardo Almeida - Programação - eduardo-almeida-II
- Rubens Praser Júnior - Programação - praser
Veja também a lista de contribuidores que participam deste projeto.
Este é um software proprietário e toda e qualquer distribuição ou modificação deve passar pela crivo dos autores.