GithubHelp home page GithubHelp logo

joyapisi / bookstore-app Goto Github PK

View Code? Open in Web Editor NEW
4.0 1.0 0.0 1.23 MB

"Bookstore App" is a web app for all fans of books. It is a Single Page App (SPA) that allows users to: Display a list of books Add a book Remove a selected book

Home Page: https://joys-bookstore-app.netlify.app/

License: MIT License

HTML 10.64% JavaScript 59.21% CSS 30.15%

bookstore-app's Introduction

Bookstore_App Project

React JS Project

๐Ÿ“— Table of Contents

๐Ÿ“– [Bookstore_App]

[Bookstore_App] "Bookstore App" is a web app for all fans of books. It is a Single Page App (SPA) that allows users to:

  • Display a list of books
  • Add a book
  • Remove a selected book By building this application, you will learn how to use React and Redux. It also follows Gitflow.

๐Ÿ›  Built With

Tech Stack

Javascript runtime environment React JS Version control

Key Features

  • [React_JS]
  • [Gitflow]
  • [Desktop-Version]
  • [Dynamic-Design]

(back to top)

๐Ÿ’ป Getting Started

Creating your first "Bookstore App" project

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

-A Git hub account -Git bash -Node JS -React JS -Visual Studio Code as your code editor

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone[(https://github.com/joyapisi/to-do-app-with-react.git)]

Understand Set Up Requirements

Since this code is using webpack, you will run npm start in your terminal to run it instead of using the live server.

Understand Set Up Requirements

Define React

React JS is a front-end library introduced by Facebook in 2013 and it has become one of the most popular ways to build modern user interfaces today.

Define Linters

A linter is a tool to help you improve your code. You can learn more about Linters here: (source: (https://www.testim.io/blog/what-is-a-linter-heres-a-definition-and-quick-start-guide/)).

Advantages of Linting:

  1. Fewer errors in production- The use of linters helps to diagnose and fix technical issues such as code smells. As a result, fewer defects make their way to production.
  2. Achieving a more readable and consistent style, through the enforcement of its rules.
  3. Having more secure and performant code.
  4. Having an objective and measurable assessment of code quality.
  5. Having fewer discussions about code style and aesthetic choices during code reviews.

Install React and Linters

Install React

  • Follow the instructions here to set up react JS.

Steps to Install React

  • In the link above, go through these topics in order:

In your project directory terminal, you can run these commands:

npm start

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

The page will reload when you make changes.
You may 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

Install Linters

Linters for various programming languages are available for use, e.g. Rubocop for Ruby or ESLint for JavaScript.

There are many ways you can integrate a linter in your workflow:

-text editor plugin -GitHub Actions -GitHub apps

Steps to Install Linters

Note: The npm package manager is going to create a node_modules directory to install all of your dependencies. You shouldn't commit that directory. To avoid that, you can create a .gitignore file and add node_modules to it:

.gitignore

node_modules/

NOTE: If you are using Windows, make sure you initialize npm to create package.json file.

npm init -y

how to use npm: (https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).

Install ESLint

  1. Run
  1. Copy .hintrc and .babelrcto the root directory of your project.
  2. Do not make any changes in config files - they represent style guidelines that you share with your team - which is a group of all Microverse students.
  3. Run
    npx eslint "**/*.{js,jsx}"
    

on the root of your directory of your project to fix linter errors.

A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.

  1. Run

npm install --save-dev [email protected] [email protected] [email protected] [email protected]

  1. Copy .stylelintrc.json to the root directory of your project.

  2. Do not make any changes in config files - they represent style guidelines that you share with your team - which is a group of all Microverse students.

If you think that change is necessary - open a Pull Request in this repository and let your code reviewer know about it. 4. Run npx stylelint "**/*.{css,scss}" on the root of your directory of your project.

  1. Fix linter errors.

  2. IMPORTANT NOTE: feel free to research auto-correct options for Stylelint if you get a flood of errors but keep in mind that correcting style errors manually will help you to make a habit of writing a clean code!

(back to top)

๐Ÿ‘ฅ Authors

๐Ÿ‘ค Joy Phoebe

๐Ÿค Contributing

๐Ÿ”ญ Future Features

[Feature-1]

  • Add more styling (aesthetics)

[Feature-2]

  • Add mobile version

(back to top)

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

โญ๏ธ Show your support

If you like this project, kindly leave a comment below and share it with someone who enjoys coding! Coding is all about continuous learning and allowing yourself to be a beginner. Keep going!

๐Ÿ™ Acknowledgments

I'm thankful to Microverse for providing a study platform which guided me through this project.

โ“ FAQ

  • [Question_1] An easier and quicker way to understand webpack?

    • This YouTubevideo will help you understand webpack better and in details
  • [Question_2] Where can I download node JS for installation?

๐Ÿ“ License

This project is MIT licensed.

(back to top)

bookstore-app's People

Contributors

joyapisi avatar

Stargazers

Abdurahim .M avatar Muhammad Zunair khan avatar Damilare Elijah ISMAILA avatar  avatar

Watchers

 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.