Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 1.83 KB

README.md

File metadata and controls

64 lines (41 loc) · 1.83 KB

MyBooks 📚

MyBooks is a bookshelf app that allows users to select and categorize books they have read, are currently reading, or want to read. Users can also search for books and add books to their bookshelf. The project is build using React and data is persisted by the backend server

Build Status Coverage Status

View the live app here :bowtie: !



Getting Started

$ git clone https://github.com/romarioraffington/react-myreads.git
$ npm install
$ npm start

Running Tests

$ npm test

Running Coverage

$ npm run coverage

Building the Project

$ npm run build

Important

The backend API uses a fixed set of cached search results and is limited to a particular set of search terms, which can be found in SEARCH_TERMS.md. That list of terms are the only terms that will work with the backend, so don't be surprised if your searches for Basket Weaving or Bubble Wrap don't come back with any results.

Contributing

Feel free to submit a pull requests! For specifics on how to contribute to this project, check out the contributing file.

License

My Reads is released under the MIT License.