BankingApi

• Este projeto faz parte do processo seletivo de recrutamento da Stone. Veja as especificações

Breve descrição do projeto

Uma API para bancos, desenvolvida em Elixir, onde é possível:

1. Criar novos usuários e novas contas bancárias
2. Realizar transferência
3. Realizar saque
4. Emitir relatório de operações bancárias realizadas por dia, mês, ano e total
5. Garantir a autenticação do usuário antes de realizar operações bancárias
6. Garantir acesso aos relatórios somente para usuários administradores

Documentação

Documentação da API

Clique aqui para encontrar a documentação da API

Documentação do código (Documentação de módulo)

Clique aqui para encontrar a documentação do código

Documentação de setup

Siga os passos a seguir para executar a aplicação localmente:

1. Instale a versão 1.10.3 do Elixir e a versão 21.0 do Erlang. Leia a documentação
2. Abra o seu terminal preferido. Nós vamos precisar para os próximos passos.
3. Execute o comando mix local.hex para instalar o hex
4. Execute o comando mix archive.install hex phx_new 1.5.4 para instalar a versão 1.5.4 do Phoenix
5. Instale a versão v10.16.3 do Node. Leia a documentação
6. Instale o Postgres. Leia a documentação
7. Execute o comando git clone https://github.com/itaayp/stone-banking-api.git para fazer um clone do projeto em sua maquina pessoal
8. Abra o arquivo dev.exs e altere as configurações de username e password para as configurações do seu banco de dados Postegresql
9. Em seu terminal, acesse o diretório do projeto e execute o comando mix ecto.create e depois mix ecto.migrate
10. Use o comando mix phx.server para executar a aplicação.
11. Neste momento, a aplicação está sendo executada na porta 4000. Para acessar os endpoints da API localmente, leia a documentação da API e para cada endpoint substitua https://stone-banking-api-itay.gigalixirapp.com por localhost:4000
12. Divirta-se! :)

Documentação de deploy

Pré-requisitos:

1. Instale python3

2. Instale pip3. Leia a documentação para mais informações

3. Instale git. Leia a documentação para mais informações

4. Crie uma conta no Gigalixir

5. Instale Gigalixir cli.

   5.1. Para isso, abra o seu terminal e rode o comando abaixo. (Obs: Após rodar o comando, mantenha o seu terminal aberto. Vamos precisar dele para as próximas etapas)

   pip3 install gigalixir --user
   

6. Execute o comando git clone https://github.com/itaayp/stone-banking-api.git para fazer um clone do projeto em sua maquina pessoal

7. Pela linha de comando, acesse o diretório do projeto e inicie o git:

cd stone-banking-api
git init

8. Adicione a track do repositório remoto:

git remote add gigalixir https://itay.profissional%40gmail.com:[email protected]/stone-banking-api-itay.git

Passo-a-passo para o deploy:

1. Faça as alterações no código.
2. Acesse o diretório onde está a aplicação

cd <APPLICATION_PATH>

3. Faça o commit das alterações:

git add .
git commit -m "I'm learning how to deploy"

4. Faça login no Gigalixir

gigalixir login

5. Faça o deploy!

git push gigalixir master

Frameworks e conceitos do ecossistema Elixir utilizados durante o desenvolvimento

1. Phoenix Framework
2. Credo - Para a análise, refatoração e legibilidade de código
3. Guardian - Para a autenticação de usuários na API
4. Exdoc - Para criar a documentação de código
5. Test Watch - para auxiliar na visualização de unit tests
6. Conceito de Fallback Controller