Find and rate books you love!
These instructions will walk you through running the project locally for development and testing purposes. See deployment for instructions on how to deploy good books on a live system.
Node.js - JavaScript Runtime. See their documentation for download instructions for your operating system.
Follow these steps to get a development environment running:
To get a copy of the project locally, clone the repository from the command line:
git clone git@github.com:cardinal-solutions/good-books.git
Point your terminal to the newly created good-books directory:
cd good-books
Start the development server:
yarn start
The full list of commands can be found in the package.json.
Good Books was created using create-react-app, using Jest as its test runner. See the Jest documentation on testing react apps as a guide for how to create test suites for new components.
To run tests defined in the /tests/ directory:
yarn test
We use prettier to enforce coding style standards and lynt to check for code smells and potential errors. These workflows run through precommit hooks defined in the package.json, to prevent committing bad code.
@TODO add deployment steps.
- Open Library API - A suite of RESTful APIs that allow us to interact with Open Library data.
Please read CONTRIBUTING.md for details on the process for submitting pull requests to good-books.