PITU - A simple micro-SaaS for URL shortening

Semana Web Full Stack

💻 Sobre o projeto

O Pitu 🦐 é um projeto ( micro-SaaS - Software as a Service ) que faz a função de encurtador de URL´s, similar ao bitly, que pega urls grandes faz o encurtamento e contabiliza as mesmas, armazenando em um banco MySql.

Diagrama do Projeto

Telas do Projeto

## 🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

• NodeJS
• ReactJS
• MySql

🚀 Como executar o projeto

Podemos considerar este projeto como sendo divido em duas partes ( MonoRepo ):

1. Back End

# Acesse a pasta backend
|- /backend/

2. Front End

# Acesse a pasta frontend
|- /frontend/

💡 O Front End precisa que o Back End esteja sendo executado para funcionar.

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, NodeJS. Além disto é bom ter um editor para trabalhar com o código como VSCode

🎲 Rodando o Back End (servidor)

# Clone este repositório
$ git clone https://github.com/brunoemferreira/pitu.git

# Acesse a pasta backend
$ cd backend

# execute o comando
$ yarn start
ou
$ npm start

# O servidor inciará na porta:3000

🧭 Rodando a aplicação web (Front End)

# Clone este repositório
$ git clone https://github.com/brunoemferreira/pitu.git

# Acesse a pasta frontend
$ cd frontend

# execute o comando
$ yarn start
ou
$ npm start

# O servidor inciará na porta:3001 ou a de sua escolha no momento