This web-app lets you upload a photo of a stack of books and add them to a virtual bookshelf.
Explore the docs »

View Demo · Report Bug · Request Feature

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

Curate your reading needs. Track your reading lists. This web-app lets you upload a photo of a stack of books. Organize books by shelves, reading status, or to borrow status. See information on a book and leave a comment. Email your bookshelves to yourself or friends. See a list of nearby libraries and bookstores based on your zip-code. Shelve-It, here to help you track and curate your reading needs.

Shelve-It uses:

• [PostgreSQL]
• [SQLAlchemy]
• [Python]
• [Pillow]
• [Flask]
• [React]
• [Handlebars.js]
• [BeautifulSoup4]
• Bootstrap

And the following APIs:

• [GoogleBooksApi]
• [GoogleCloudVisionAPI]
• [GooglePlaces]
• [SendGrid]
• [GeoCoder]

Shelve-It is deployed on an AWS LightSail Instance. Please go to Shelve-It.com to test it out. If you would like to deploy locally, follow the below steps.

Make sure your pip is updated and you are running Python 3.6 or greater.

1. Get a free API Key at https://developers.google.com/maps/documentation/javascript/get-api-key
2. Clone the repo

git clone https://github.com/shhudspeth/hb-project-shelve-it/

3. Install requirements.txt

pip3 install -r requirements.txt

4. Enter your API key and SendGrid key in secrets.sh

source secrets.sh

Below are instructions and main features of Shelve-It.

1. Uploading a Bookshelf

2. Making a Bookshelf
3. Add a Book to a Bookshelf
4. Email a Bookshelf

5. Display by a Shelf

6. Add or View Comments by a Book

-- coming soon! -- See the open issues for a list of proposed features (and known issues).

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Distributed under the MIT License. See LICENSE for more information.

Your Name - @sarahhhuds - sarah@shelve-it.com

Project Link: https://github.com/shhudspeth/hb-project-shelve-it/

• GitHub Emoji Cheat Sheet
• Img Shields
• Choose an Open Source License
• ReadMe Template