gregorispielmann / bookfinder

BookFinder

---

A React.js and Express.js project made using GoogleBooks API.

📝 Table of Contents

• About
• Getting Started
• Usage
• Built Using
• Contributing
• Authors
• Information

🧐 About

This is a study project build using React.js with some libs and a API with Node.js, Express.js and other libs.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them.

You need yarn or npm to run this application

Installing

Clone this repo using the address https://github.com/gregorispielmann/bookfinder.git

Running em Dev Mode

Creating your AppSecret (.env)

You will find inside server folder a file with .env.example name, you need to rename that to .env and inside that put your own APP_SECRET Key.

APP_SECRET=yoursecretkey

Backend (Server)

Install dependencies, run Knex migrations and Seeds, start the server with nodemon using Yarn or Npm

Inside the clone folder run the commands below.

YARN
$ cd server && yarn && npx knex migrate:latest && npx knex seed:run && yarn server

NPM
$ cd server && npm install && npx knex migrate:latest && npx knex seed:run && npm run server

Screenshots

Frontend (Web)

Install dependencies and start the web using Yarn or Npm

Inside the clone folder run the commands below.

YARN
$ cd web && yarn && yarn start

NPM
$ cd web && npm install && npm run start

With the steps above you will be ready to test the application.

WEB > http://localhost:3000 SERVER > http://localhost:4000

🎈 Usage

To use the system you will need the login email and password.

When you run the Knex seed you will put a demo admin user with this data:

Email: [e-mail] Password: 123456

You just need this infos to login in the web application.

⛏️ Built Using

• ReactJS - Web JS Library
• Express - Server Framework
• NodeJs - Server Environment
• Knex - SQL Query Builder
• SQLite3 - Local Database
• axios - HTTP Client
• Styled Components - CSS in JS
• and others

✍️ Authors

• @gregorispielmann

🎉 TODOS, Facilidades, dificuldades e horas

TODOS

• Acrescentar Redux e inserir informações que necessitem ser compartilhadas entre componentes tais como quantidade de favoritos para o header

Facilidades

• Criação do frontend React.js em geral
• Criação do backend utilizando Node.js e Express.js

Dificuldades

• Uso da API do Google (retornos confusos)

Horas trabalhas (estimadas) - 16h