Giter Club home page Giter Club logo

proj-class-2020's Introduction

Project Plan for Code Lou Proj Class 2020

Project Summary

My project will allow the user to search for books in open library search API based on author or title. Search results will display the title and author.

There will be two buttons on the home screen that read "Search by title" and "Search by author". When clicked, a search field will appear below in which you can type your respective search criteria. The url route will also change once one of these buttons is clicked.

There will be a carousel on the home page from the New York Times Best Seller API that displays a thumbnail of the book, its rank, the title, and the author, as well as a link to where you can purchase the book.

There will be a "Useless Fact", fetched from Random Useless Facts API, at the bottom of the page that loads a different useless fact every time the page loads.

Technical Summary

I'll be using Create React App with React Router Dom (React/JS), the open library search API, the New York Times Best Seller API, and the Random Useless Fact API.

Features

  1. Users will be able to input a search parameter for a book based on author or title.

  2. There will be buttons on the home page to select the way the user will search for a book (i.e, Search by Title, Search by Author).

  3. There will be a carousel on the home page that displays various top selling books rated by the New York Times.

  4. There will be a random useless fact generated at the bottom of the page every time the page loads.

Milestones

  1. Design wireframes for each page.

  2. Create a repo and import all packages I'll need.

  3. Build and connect all pages.

  4. Make and consume API requests.

Requirements to run project

  1. Clone repo

  2. Cd into directory

  3. Run npm install

  4. Run npm start and go to http://localhost:3000/


Everything beyond this point is typical README info for Create React App

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

proj-class-2020's People

Contributors

aclaycomb0004 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.