Skip to content

Final project for Udacity's React Nanodegree: A book tracking app with categorization and search functionalities.

Notifications You must be signed in to change notification settings

nohahakim/reactnd-myreads

Repository files navigation

MyReads App

MyReads is a book tracking application developed as the final assessment project for Udacity's React Fundamentals course, part of the React Nanodegree program. This app allows users to categorize books into three shelves: Currently Reading, Want to Read, and Read. Additionally, users can search for new books to add to their collection.

Features

  • Categorize Books: Organize your books into different shelves based on your reading status.
  • Search Functionality: Find and add new books to your shelves using the search feature.
  • Responsive Design: Enjoy a seamless experience across various devices and screen sizes.

Getting Started

Follow these instructions to set up and run the project locally.

Prerequisites

Ensure you have Node.js and npm (or Yarn) installed on your machine.

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/myreads-app.git
    cd myreads-app
  2. Install dependencies:

    Using npm:

    npm install

    Or using Yarn:

    yarn install

Running the Application

Start the development server to run the app locally.

Using npm:

npm start

Or using Yarn:

yarn start

The app will open in your default browser at http://localhost:3000.

Contributing

This project is an assessment for Udacity's React Nanodegree and is not open for external contributions.

License

This project is licensed under the MIT License.

Technologies Used

  • React: Frontend library for building user interfaces.
  • React Router DOM: Handling routing within the application.
  • Prop-Types: Runtime type checking for React props.
  • React Debounce Input: Debounced input component for optimized search functionality.
  • React Scripts: Configuration and scripts for Create React App.
  • Gh-Pages: Deploying the application to GitHub Pages.

Scripts

The following scripts are available in the project:

  • Start Development Server

    npm start
    # or
    yarn start
  • Build for Production

    npm run build
    # or
    yarn build
  • Run Tests

    npm test
    # or
    yarn test
  • Deploy to GitHub Pages

    npm run deploy
    # or
    yarn deploy

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

Final project for Udacity's React Nanodegree: A book tracking app with categorization and search functionalities.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published