nitbravoa92 / bookstore

Development of a web page to add and display books using ReactJS and Redux as application state handler.

Bookstore WebApp

📗 Table of Contents

• 📗 Table of Contents
• Bookstore WebApp
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • 🚀 Live Demo
  • 💻 Getting Started
    • Setup
    • Prerequisites
    • Install
    • Usage
    • Build
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

Bookstore WebApp

Bookstore is a books web application built with ReactJS, where users can see a list of the latest most famous books added and obtain detailed information about them. In addition, users can add a new book and choose which ones to remove. This webapp will consist of 2 pages: The Books page and the Categories page. In this first version, only the Books page will be 100% finished.

🛠 Built With

Tech Stack

Client

• React Library
• React Router
• Node.js
• Create React App
• Stylelint.io
• ESlint.org
• Redux Toolkit

Key Features

• Using the ReactJS library
• Using the ReactJS Router library
• Using JSX syntax
• Using semantic HTML
• SPA Approach
• Responsive Design
• Using Redux Toolkit for a global state management

(back to top)

🚀 Live Demo

To see the application working live, you can click on the following link that contains the demo version:

• Bookstore WebApp - Live Demo

(back to top)

💻 Getting Started

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

Setup

Clone this repository to your desired folder:

  cd my-folder-name
  git clone [email protected]:NitBravoA92/bookstore.git

Prerequisites

In order to install, modify and run this project, it is necessary to have the following applications installed:

• Git: to manage the project versions of source code. You can Download Git here

• Nodejs and NPM: to install and manage the project dependencies. Nodejs and NPM installation guide

• A code editor like Visual Studio Code (Recommended) or any other of your preference. It is necessary to open the project and add or modify the source code. You can Download Visual Studio Code here

It is also important to have at least basic knowledge about ReactJS, JSX, HTML, CSS and Javascript languages so you will be able to understand and work with the code of the project.

• Learn the basics of HTML
• Learn the basics of CSS
• JavaScript basics
• Javascript Arrays
• Javascript Objects
• JavaScript modules
• ReactJS
• JSX
• Create React App

Install

Install this project by running the next command into your project folder:

  npm install

All the packages and libraries necessary for the project to work will be installed in a folder called /node_module. After this installation, the project will be ready to use.

Usage

In the project directory, you can run:

• 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 CSS and JS linters errors in the console running the following commands:

CSS Linter

  npx stylelint "**/*.{css,scss}"

Javascript Linter

  npx eslint "**/*.{js,jsx}"

Build

• 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.

Note: Please only modify the components files and the CSS files. Do not modify configurations files of the project.

👥 Authors

👤 Nitcelis Bravo

• GitHub: Nitcelis Bravo
• Twitter: @softwareDevOne
• LinkedIn: Nitcelis Bravo Alcala

(back to top)

🔭 Future Features

• Initialize project with components
• Add reducers and actions
• Use Redux to manage the state of the components
• Connect to the Bookstore API
• Add CSS styles to the UI following a proposed design.

(back to top)

🤝 Contributing

Contributions, issues, suggestions and feature requests are welcome! Feel free to check the issues page.

To do Contributions, please fork this repository, create a new branch and then create a Pull Request from your branch. You can find detailed description of this process in: A Step by Step Guide to Making Your First GitHub Contribution by Brandon Morelli

(back to top)

⭐️ Show your support

If you liked this project, give me a "Star" (clicking the star button at the beginning of this page), share this repo with your developer community or make your contributions.

(back to top)

🙏 Acknowledgments

I would like to thank my Microverse teammates for their support. They have supported me a lot in carrying out this project, giving me suggestions, good advice and solving my code doubts.

📝 License

This project is MIT licensed.

(back to top)