Git Product home page Git Product logo

rd-book-store's Introduction

Book Store Resultados Digitais

Your digital bookshelf on the web

  1. About
  2. Usage
  3. Project Structure
  4. Browser Compatibility
  5. Automated Tests

About

This is an open source project that aims facilitate the search of books by people on Google Books API. Basically, this app gives the user a custom experience which it is possible to search, read and bookmark his books.

Usage

Anyone can clone this repo and collaborate to either improve the actual features or create new ones. In order to develop this project, you will the following requirements.

  1. clone this repo, or fork it.
  2. Make sure you have both NodeJS and npm installed.
  3. In a terminal, in the project root directory, run npm install.
  4. After install the dependencies, run npm run watch.
  5. Open your browser and visit http://localhost:5000/

You will see the Book Store Home page. Now, you can open your editor and start coding. Every time you save some file, eslint will check your code. If all its right, the browser will reload the page.

Project Structure

This project is built up with front end technologies such as NodeJS and React. For development uses Eslint code checker and Webpack task runner. The application architecture pattern chosen was Redux, which is a Unidirectional Data Flow pattern. For automated tests, not implemented yet, the project will use Jest altogether with Airbnb enzyme, a test utility for React applications. This application works with Continuous Integration on Heroku, which is automatically deployed every time a new merge is made on master branch. You can check this app on https://rd-book-store.herokuapp.com/#/.

Browser Compatibility

This release version (1.0.0) uses Flexible Box Layout, which is compatible with Firefox 51, Internet Explorer 11, Microsoft Edge, Chrome 55 and modern mobile browsers. The next stable version should brings flex box fallback for old browsers, and a responsive version for small screens.

Automated Tests

Automated tests comming soon with Jest and Airbnb enzyme on next minor release.

rd-book-store's People

Contributors

darde avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

zahedbri

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.