DEV.DUCK

Trata-se do desenvolvimento de um sistema web, Dev.Duck, que tem como objetivo criar uma plataforma aberta e simples para que estudantes do curso de ADS possam publicar seus conhecimentos e experiências relacionados às matérias de suas grades curriculares.

Essa plataforma permite que os acadêmicos compartilhem links de matérias complementares ou até texto de suas anotações das aulas, que poderão ser vistos na plataforma. Com o Dev.Duck, queremos oferecer aos estudantes uma maneira fácil de se conectar e aprender uns com os outros.

---

Começando   |    Pré-requisitos   |    Instalação   |    Construído com   |    Licença

Telas do Sistema

🏗️ Diagrama de classes UML

Para visualizar e entender melhor a estrutura do projeto.

🚀 Começando

Essas instruções permitirão que você obtenha uma cópia do projeto em operação na sua máquina local para fins de desenvolvimento e teste.

📋 Pré-requisitos

Você precisa ter duas principais dependências instaladas:

Python 3.10.6
Django 4.2.1

🔧 Instalação

1 - Passo: Clone

Realize um clone do projeto em seu computador

https://github.com/RochaGabriell/ProjetoIntegradorI.git

2 - Passo: Criação e Ativação do Ambiente Virtual

Crie um ambiente virtual na pasta raiz do projeto. No seu terminal use:

Linux:

2.1 - Criação

python3 -m venv venv

2.2 - Ativação

source venv/bin/activate

Para Windows ou Mac:

Consulte a documentação da linguagem Python

3 - Passo: Instalação de depedências

É preciso instalar as depedências do projeto para o funcionamento correto. Com o seu ambiente virtual ativo use o comando no seu terminal:

pip install -r requirements.txt

4 - Configure os dados do arquivo .env

Para a correta execução do projeto é necessário a configuração das variáveis de ambiente.

• Crie um arquivo .env na raiz do projeto

DJANGO_SECRET_KEY='Sua SECRET_KEY'

DATABASE_URL='URL que aponta para o banco de dados utilizado.'

EMAIL_HOST_USER='usuário para autenticação em um servidor de e-mail.'
EMAIL_HOST_PASSWORD='senha para autenticação em um servidor de e-mail.'
DEFAULT_FROM_EMAIL='endereço de e-mail padrão utilizado.'

5 - Passo: Realize as migrações

Isso garante que o seu banco de dados esteja sincronizado com a estrutura do seu projeto.

python manage.py migrate

6 - Passo: Executar o projeto

python manage.py runserver

http://localhost:8000/

Observações:

• Para derrubar todos os serviços, basta utilizar as teclas CTRL+C, que é o padrão dos terminais para matar processos.
• Para iniciar com dados iniciais ou de backup em nosso banco de dados, você pode usar o comando a seguir: ./manage.py loaddata db_backups/db.json

🔍 Funcionalidades

As principais funcionalidades da aplicação são:

• RF.01 - Login e Cadastro de usuários;
• RF.02 - Tela inicial;
• RF.03 - Criar uma postagem;
• RF.04 - Visualização de postagens;
• RF.05 - Edição de postagens;
• RF.06 - Avaliação de postagens;
• RF.07 - Editar perfil;
• RF.08 - Recuperação de senha;
• RF.09 - Área de administração;
• RF.10 - Filtro de conteúdo;
• RF.11 - Visualizar de perfil.

🛠️ Construído com

• Python - Linguagem de programação amplamente usada em aplicações da Web.
• JavaScript - Linguagem de programação usada para fazer páginas interativas da Internet.
• Django Framework - O framework web usado na criação do projeto.
• Showdown - Um conversor bidirecional Markdown para HTML escrito em Javascript!.
• PostgreSQL - Banco de dados utilizado ao fazer deploy.
• HTML - Estruturação da página
• CSS - Estilização da página

📄 Licença

Este projeto está sob a licença (MIT License) - veja o arquivo LICENSE.md para detalhes.

---