Skip to content

kuldeeepy/OpenBook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

66 Commits
 
 
 
 
 
 
 
 

Repository files navigation

OpenBook

OpenBook is a web app where you can browse, read, and download books in PDF format for free. Explore genres, search top titles, and enjoy seamless access to your favorite reads. Perfect for book lovers!

Directory Structure

OpenBook/
├── backend/
│   ├── .dockerignore
│   ├── .gitignore
│   ├── Dockerfile
│   ├── index.js
│   ├── package-lock.json
│   └── package.json
|
├── frontend/
│   ├── src/
│   │   ├── components/
|   |   |   ├── BookCard.jsx
|   |   |   ├── Collection.jsx
|   |   |   ├── Footer.jsx
|   |   |   ├── Layout.jsx
|   |   |   ├── Loader.jsx
|   |   |   ├── Nav.jsx
│   │   |   └── Private.jsx
│   │   ├── context/
│   │   |   └── AuthContext.jsx
│   │   ├── pages/
|   |   |   ├── Book.jsx
|   |   |   ├── Home.jsx
|   |   |   ├── Login.jsx
|   |   |   ├── Signup.jsx
│   │   |   └── Verify.jsx
|   |   ├── services/
│   │   |    └── service.jsx
│   |   ├── App.jsx
│   |   ├── index.css
│   |   └── main.jsx
│   ├── index.html
│   ├── vercel.json
│   └── vite.config.js
├── README.md
└── package.json

Endpoints

  Primary URL https://openlibrary.org

Get books by Subject

  GET /subjects/fantasy.json?limit=10&offset=0
  GET /subjects/kids.json?limit=10&offset=0
Parameter Type Description
subjects string Required. to fetch item

Search books by name

  GET /search.json?q=the+lord+of+the+rings
  GET /search.json?title=harry+potter
Parameter Type Description
q string Required. to fetch item
title string Required. to fetch item

Getting started locally

To set-up on your local system, enter the following commands in your terminal:

# clone the repository
git clone https://github.com/kuldeeepy/OpenBook.git

# move into directory
cd OpenBook

# Add the following environment variables to your .env file
`VITE_ENDPOINT` | `VITE_API_KEY` | `VITE_IMAGE_URL` |
`VITE_FALLBACK_URL` | `VITE_FIREBASE_URL`

Enjoy, happy coding!

Snapshot

App Screenshot

Get in touch

Website linkedin twitter

About

OpenBook lets users browse, read, or download e-books across all genres.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors