Giter VIP home page Giter VIP logo

bookie-app's Introduction

Logo

Project Description

Bookie is a web-based editor for keeping notes or bookmarks for books that individuals are currently reading. The application uses Google Books API and Bookie API for authentication.

Done

We have completed the following things thus far:

  • Project setup
    • React.js
    • MobX for state management
  • Views
    • Login
    • Sign Up
    • Not found page
    • Search Bar
    • Book details
    • Notes
    • Recent notes
  • API integration
    • Google Books API search call
    • Bookie API calls (login, sign up, notes)
  • Logo Created

To do

  • Notes management (creating, editing, adding)
  • Using in-browser persistent storage to keep notes (offline mode)
  • Notes export (PDF, epub)

Your project file structure:

Components

src/components/
├── about
│   └── About.js (about page)
├── book
│   └── BookView.js (detailed book view)
├── book-card
│   └── BookCard.js
├── book-search
│   └── BookSearch.js
├── dashboard
│   └── DashboardWrapper.js
├── home
│   └──  HomeView.js
├── login
│   └── LoginForm.js
├── note-card
│   └── NoteCard.js
├── note-create
│   └── NoteCreateView.js
├── notes
│   └── NotesView.js
├── not-found
│   └── NotFound.js
├── private-route (restricting access to confidential data)
│   └── PrivateRoute.js
└── signup
    └── SignUpForm.js

Each module exports one dumb react component. Additionally, some modules export container components. Using mobx-react library and React Context API we inject properties of preconfigured mobx stores.

Services :

api-service

Defines the interface for calling the authentication API.

books-search-services.js

Defines the interface for calling the Google Books API.

Stores

There are three store classes for managing the state of the displayed books, authenticated user and the notes taken.

Each file in the folder defines the class and its methods for setting the state for the given entity.

routes.js :

This file contains the route definitions and which components should be rendered.

app.js:

Root component for the application. Initialising the state management stores and the rest of the application (routes.js).

bookie-app's People

Contributors

adaszyn avatar vshivam avatar ranjini1992 avatar ksoutar15 avatar

Watchers

zw avatar  avatar

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.