Bem-vindo ao repositório do nosso projeto Bookheaded. Nossa plataforma está sendo desenvolvida como parte da disciplina de Fundamentos de Software (FDS) para criar uma comunidade interativa entre os leitores, permitindo que eles compartilhem e discutam suas leituras de forma mais envolvente. Este novo projeto, chamado Bookheaded, visa principalmente aprimorar e promover conexões significativas através do amor pela leitura.
-
Linguagem de Programação:
-
Banco de Dados:
-
Framework de Desenvolvimento:
-
Frontend:
-
Organização:
Seja bem-vindo ao BookHeaded! Siga este guia para entender como acessar sua conta, explorar clubes de leitura e participar da comunidade.
Página Inicial: Quando você visita o BookHeaded, a primeira coisa que verá é a página inicial com uma breve introdução sobre o site e os clubes de leitura mais populares.
Login ou Cadastro: Se você já possui uma conta, clique no botão Login no canto superior direito. Se ainda não tiver uma conta, clique em Register para criar uma nova.
Acesse a Página de Login:
Insira o seu nome de usuário e digite sua senha no campo apropriado.
Se as informações estiverem corretas, você será redirecionado para a sua página inicial de usuário.
Não Tem Conta? Cadastre-se: 📝
Para novos usuários, preencha um pequeno formulário com nome, senha e reconfirmando a senha.
Depois de cadastrado, você pode fazer o login e começar a explorar o site.
No BookHeaded, os clubes de leitura são o coração da experiência, permitindo que você se conecte com outras pessoas que compartilham interesses de leitura semelhantes.
Como Funciona: No menu principal, clique em Clubs para ver uma lista de clubes disponíveis. Explorar Clubes:
Use a barra de pesquisa ou explore as categorias para encontrar clubes de acordo com seus interesses, como ficção científica, literatura clássica, ou autores contemporâneos. Juntar-se a um Clube 🤝:
Para participar de um clube, clique em Entrar no perfil do clube escolhido. Você será automaticamente adicionado à lista de membros do clube e poderá participar das discussões. Acompanhar Atividades 📆:
Dentro do clube, você verá as discussões em andamento, o progresso do clube e o capítulo atual, além de ver mais informações do clube como a quantidade de membros, quantas pessoas classificaram e qual a classificação média entre 1 e 5 ⭐.
Uma vez que você esteja em um clube, participar das discussões é simples:
Acesse o Fórum do Clube:
Cada clube tem um fórum onde os membros podem comentar, discutir livros ou compartilhar resenhas.
Adicionar à Sua Lista de Leitura ➕:
Ao clicar em um Clube e Entrar, você pode adicioná-lo à sua lista de leitura pessoal, "My clubs" onde poderá acompanhar o progresso da leitura e compartilhar resenhas depois de terminar. Recomendar Livros ✨:
Como membro de um clube, você pode sugerir novos livros para a lista de leitura do grupo na área de comentários.
Posso criar meu próprio clube de leitura?
Sim! Basta clicar em "New Club" e preencher as informações necessárias. Você poderá gerenciar o clube e convidar outros leitores para participar. Como posso encontrar novos livros? 📖
Explore as recomendações dos membros em cada clube ou veja a seção de Destaques da Comunidade, onde livros populares são apresentados com base na interação da comunidade. Posso participar de mais de um clube? 🔄
Claro! Você pode participar de quantos clubes quiser e gerenciar suas participações na seção de "My Clubs".
Bem-vindo ao projeto BookHeaded! Obrigado por considerar contribuir para o nosso projeto! Siga as instruções abaixo para configurar o ambiente de desenvolvimento.
Antes de começar, certifique-se de ter o seguinte instalado na sua máquina:
Abra seu terminal e navegue até o diretório onde deseja clonar o repositório. Em seguida, execute o comando abaixo:
git clone https://github.com/Carlosesposito22/BookHeaded.git
Use o comando
cd BookHeaded
Para criar um ambiente virtual, execute o seguinte comando:
python -m venv venv
Para ativar o ambiente virtual:
source venv/Scripts/activate
source venv/bin/activate
Com o ambiente virtual ativado dentro da mesma pasta, instale as dependências necessárias:
pip install -r requirements.txt
Realize as migrações no banco usando: (Note que em algums dispositivos é usado py como prefixo ao inves de python)
python manage.py migrate
Finalmente, para iniciar o servidor de desenvolvimento, execute:
python manage.py runserver
Agora, você deve ser capaz de acessar o aplicativo em seu navegador, normalmente o servidor local é http://localhost:8000/.
Recomendamos o uso do Visual Studio Code (VSCode) para desenvolver o projeto. Para abrir o projeto no VSCode, siga os passos abaixo:
Clique em File > Open Folder... e selecione o diretório do projeto BookHeaded. Certifique-se de que o ambiente virtual esteja ativado no terminal do VSCode.
Nossa equipe irá analisar todos os pull requests. Apenas aqueles que forem coerentes e estiverem alinhados com os objetivos do projeto serão aprovados.
Se tiver qualquer dúvida, sinta-se à vontade para abrir uma issue.
- Para fazer uma boa contribuição siga as boas práticas de codificação em Python, HTML e CSS.
- Formatação correta do código.
- Ordem de imports correta no código.
KickOff
Entrega 3
Entrega 4
- Amanda Montarroios - amo@cesar.school 📩
- João Micucci - jhmm@cesar.school 📩
- Malu Dantas - mldt@cesar.school 📩
- Mateus Ribeiro - mar2@cesar.school 📩
- João Pedro Mamede - jpmd2@cesar.school 📩
- Carlos Eduardo Espósito - ceec@cesar.school 📩