- Fábio Augusto Araújo Santos
- Luana Assis Silva
- Vinícius Dalcantoni Horta Barbosa
- Bruno de Oliveira Silva
- Matheus Santiago de Andrade Marques
O My Book List é uma rede social destinada a leitores.
Na plataforma, estão disponíveis as seguintes funcionalidades:
- Criar listas das suas obras lidas, com leitura em andamento, leituras paradas e as que estão na sua lista de desejos;
- Adicionar detalhes a cada obra contida em suas listas, como: nota, review e status;
- Adicionar amigos e visualizar perfis de outros usuários;
- Personalizar seu próprio perfil, alterando sua foto e nome e definindo seus livros favoritos.
A ideia do projeto surgiu a partir de um interesse em comum: a leitura. A leitura traz diversos benefícios, tanto no âmbito pessoal como profissional, visto que desenvolve o pensamento crítico, diminui o estresse, aumenta o vocabulário, expande a criatividade, exercita o cérebro e aumenta a concentração, dentre outras inúmeras vantagens.
Visto isso, em um mundo integrado com o virtual, a plataforma foi criada no intuito de incentivar a leitura e integrar pessoas.
Para o desenvolvimento o projeto foi dividido em duas seções, seguindo uma estrutura MVC e HTTP/REQUEST.
O front-end do projeto foi desenvolvido com React JS.
Para rodar é necessário executar npm install
para baixar suas dependências. Com as dependências instaladas, para inciar é necessário o comando npm start
.
Ambos os comando devem ser executados na pasta raiz.
O back-end do projeto foi desenvolvido com Node JS, utilizando a biblioteca Express.
Para rodar é necessário executar npm install
para baixar suas dependências. Com as dependências instaladas, pode-se inciar o projeto, que pode ser executado de duas formas.
A primeira delas como desenvolvedor, a partir do comando npm run dev
, onde será inciado através da biblioteca nodemon. A segunda forma é como deve ser feito em produção/servidor, através do comando npm run start
ou node ./src/server.js
.
A documentação do projeto é feita a partir do Swagger. Para inciar o processo de gerar/atualizar a documentação de forma automática é necessário executar o comando npm run doc
.
Ambos os comando devem ser executados na pasta raiz.