README.md

✂️🔗 URL Shortener

Tecnologias   |    Projeto   |    Como contribuir   |    Como rodar   |    Licença

🚀 Tecnologias

Esse projeto foi desenvolvido com as seguintes tecnologias:

• Node.js
• Typescript
• MongoDB

💻 Projeto

Esse projeto é uma API REST desenvolvida, com Node.js e Typescript, baseada em um desafio de backend do Backend-Br. O intuito do desafio foi criar um serviço que inicialmente recebe como parâmetro uma URL que deverá ser encurtada seguindo as seguintes regras:

1. Mínimo de 5 e máximo de 10 caracteres.

2. Apenas letras e números.

A url retornada deve ser salva no banco de dados e possuir um prazo de validade e ao receber uma url encurtada, deve fazer o redirecionamento para a url salva no banco. Nesse projeto usei o MongoDB como banco de dados.

🤔 Como contribuir

• Adicione uma ⭐ estrela nesse projeto 😄;
• Faça um fork desse repositório;
• Cria uma branch com a sua feature: git checkout -b minha-feature;
• Faça commit das suas alterações: git commit -m 'feat: Minha nova feature';
• Faça push para a sua branch: git push origin minha-feature.

Depois que o merge da sua pull request for feito, você pode deletar a sua branch.

▶️ Como rodar

• No seu terminal, rode o comando para instalar as dependências do projeto: yarn;
• Crie uma cópia do arquivo .env.example com o nome .env (na raiz) e defina suas variáveis de ambiente;
• Rode o comando para iniciar o servidor (em modo desenvolvimento): yarn start:dev;

Se tudo ocorrer bem, a aplicação vai estar disponível em: http://localhost:3333.

📝 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

---

Feito com ♥ by Danilo Gonçalves. Me adicione no LinkedIn 👋