/reactnd-project-myreads

React project for the Udacity React Nanodegree program

Primary LanguageJavaScriptMIT LicenseMIT

Have a question or suggestion? Contact me on Linkedin, or open a pull request on this project.

Programming assignment for the Udacity React Nanodegree program.


MyReads

Code Climate Issue Count

Simple app to manage lists of current reading, want to read and already read books.

Built with React and React Router. This project was bootstrapped with Create React App. You can find more information on how to perform common tasks here. The starter template for the assignment (including CSS styles) can be found here.

Hosted on: https://fernandobrito.github.io/reactnd-project-myreads

API

This applications consumes data from an API designed specifically for the assignment.

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.

Installation

Installs all necessary modules to run the current project.

$ npm install

Development

Runs development server, with live reloading, on http://localhost:3000.

$ npm start

Build

Builds the app for production to the build folder.

$ npm run build

Lint

Run lint tools.

$ npm run eslint

Deploy

Deploys the to GitHub Pages app using gh-pages package.

$ npm run deploy

Contributing

  1. Fork it
  2. Create your feature branch with specs (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Contributors

License

This project is licensed under the MIT License. Check the LICENSE file.