Skip to content

danielmsilverio/short_url

Repository files navigation

ShortURL

Badge em Desenvolvimento

Este é um projeto de estudos, com a finalidade de demonstrar minha familiaridade com a linguagem elixir e outros pontos de interesse.

Para mais informações de como desenvolvi e os desafios, indico ler o arquivo Como Desenvolvi

ShortURL é uma api para realizar encurtamento de URLs.

⚙️ Funcionalidades do Projeto

  • CRUD usuário: possível criar/ver/atualizar/deletar dados do usuário
  • Criar encurtador da url: possível encurtar uma URL, onde é associada ao usuário

▶️ Como iniciar o projeto

Via Docker

docker compose up -d

Via asdf

  • Instalar o asdf

  • executar: asdf install no terminal do projeto

  • Execute mix setup para instalar as dependencias

  • Para iniciar o serviço, execute mix phx.server

Com o projeto rodando:

É possível executar os comandos básicos:

curl --request POST \
  --url http://localhost:4000/api/users \
  --header 'Content-Type: application/json' \
  --data '{
	"user": {
		"name": "Daniel",
		"email": "[email protected]",
		"password": "teste"
	}
}'

resultado esperado:

{
	"data": {
		"id": 1,
		"name": "Daniel",
		"email": "[email protected]"
	}
}

🧪 Rodando os testes

  • Para executar os testes, é necessário apenas rodar mix test

🛠️ Tecnologias utilizadas

Elixir Postgres Githubactions Docker

🆙 Melhorias a serem realizados

  • Adicionar autentificação
  • [ x ] Alterar para rodar em docker
  • [ x ] Adicionar pipeline CI
  • Ajustar para apróximar de Clean Architecture

About

Projeto de estudos - criação de sistema backend para encurtar urls

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages