Skip to content

dlfedie/readMe

Repository files navigation

ReadMe

This is a full stack app that allows a user to add books to a library, take notes on them, and categorize them by currently reading or want to read. This app hooks into Google Books api to retrieve book data.

A demo deployed to heroku can be viewed here: https://evening-atoll-19955.herokuapp.com/

Built With

Getting Started

Download or clone this repo. Then setup the database as outlined in the database.sql file.

Prerequisites

Link to software that is required before you attempt to start the app (e.g. node, mongo).

  • Node.js
  • Some sort of local SQL database (Postico is what I used)

Installing

Steps to get the development environment running.

  1. Download this project.
  2. Create a database named prime_app
  3. Run the queries to setup the tables in the database.sql file
  4. Create a Google Books api key, follow instructions here: https://developers.google.com/books
  5. Get your key added to a local .env file. Add this line, followed by your Gbook api key: GOOGLE_BOOKS_API_KEY=
  6. Run npm install to install all dependancies.
  7. npm run server
  8. npm run client

Screen Shot

Will add screen shots at a later date.

Documentation

Link to a read-only version of your scope document or other relevant documentation here (optional). Remove if unused.

Completed Features

Next Steps

Deployment

Authors

Dustin Fedie

Acknowledgments

Hat tip to Google Books for letting me use their api. Also, all of the staff and students at Prime Digital Academy, you folks are amazing.

About

Solo project app to track reading progress

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages