Kairos WebApp 💻

📦 Tecnologias usadas:

• Django(Backend)
• Django REST Framework(API)
• Vue 3(Composition API com script setup)
• Tailwind CSS
• Quasar 2(Framework para construção de aplicações Vue.js)
• Pinia(Gerenciamento de estado)
• Vue-Router(Gerenciamento de rotas)
• Axios(Integração de APIs)
• Bootstrap Icons

🔥 Introdução:

⚙️ Pré-requisitos:

Você precisa ter instalado na sua máquina as seguintes tecnologias:

• Node
• Python

*Obs.: Desenvolvi este projeto com Node 20.x e Python 3.12.x. Não testei o projeto em versões anteriores destas tecnologias.

🔨 Guia de instalação:

Passo 1: Clone esse repositório

git clone git@github.com:EmanuelLacerda/kairos-webapp.git

Passo 2: Acesse a pasta do respositório

cd kairos-webapp

Passo 3: Instale as dependências

Neste repositório, há 2 diretórios, sendo um deles a api(server/) e o outro o frontend(web/). Cada repositório possuí dependências próprias. Então, você precisa instalar as dependências individualmente. Abaixo segue como fazer para cada um dos dois.

1° Acesse o diretório "server":

cd server

2° Execute o "pip3 install -r requirements.txt":

pip3 install -r requirements.txt

3° Volte para a raiz do projeto:

cd ..

4° Acesse o diretório "web":

cd web

5° Execute o comando "npm install":

npm install

6° Volte para a raiz do projeto:

cd ..

Passo 04: Adicione as variáveis de ambiente no diretório server

Ao acessar server/.env.examples você verá o seguinte conteúdo:

SECRET_KEY=
DEBUG=
DB_NAME=
DB_USER=
DB_PASSWORD=
DB_HOST=
DB_PORT=
EMAIL_HOST=
EMAIL_HOST_USER=
EMAIL_HOST_PASSWORD=
EMAIL_PORT=

Explicação sobre as varíaveis:

• SECRET_KEY: Coloque nesta a SECRET_KEY que você tiver gerado para a aplicação Django.
• DEBUG: Coloque nesta um boolean indicando se o projeto está ou não no debug mode.
• DB_NAME até DB_PORT: Coloque nestas as informações do banco relacional em você salvará os dados. De preferência, utilize um banco PostgreSQL, pois o projeto foi desenvolvido pensando neste banco.
• EMAIL_HOST até EMAIL_PORT: Coloque nestas as informações do host de e-mail que será utilizado para enviar as mensagens via e-mail.

Passo 05: Execute o projeto

1° Acesse o diretório server:

cd server

2° Execute as migrations:

python3 manage.py migrate

3° Execute a api:

python3 manage.py 

4° Acesse o diretório web:

cd web

5° Execute o frontend:

npx quasar dev #ou
quasar dev #este segundo comando só funcionará se tiver o Quasar instalado globalmente

*Obs.: Para o projeto funcionar corretamente, api e frontend devem estar em execução ao mesmo tempo.

👷 Autores

• Emanuel Lacerda - Desenvolvedor - @EmanuelLacerda

📄 Licença

Esse projeto está sob a licença MIT - acesse os detalhes LICENSE.md.

Créditos:

O layout das telas de login, criar conta e similares foram baseadas neste design de tela de login publicado no FIGMA pelo usuário Ajay Gorecha(@gorechajay)

✉️ Contato

Se tiver alguma dúvida, quiser fazer sugestões, elogios, etc., se sinta livre para entrar em contato comigo por meio de um dos contatos abaixo:

• in/emanuel-de-souza-lacerda
• emanuelsouzalacerda@gmail.com