An open API service indexing awesome lists of open source software.

https://github.com/cancelei/awesome-books

Main learning points: Use Javascript to add, remove and display books as objects in the Bookshelf (list of books). Made during Microverse Coding School.
https://github.com/cancelei/awesome-books

List: awesome-books

website

Last synced: 5 months ago
JSON representation

Main learning points: Use Javascript to add, remove and display books as objects in the Bookshelf (list of books). Made during Microverse Coding School.

Awesome Lists containing this project

README

          



HTML, CSS and JavaScript Book List Storage Website


# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [🚀 Live Video](#live-video)
- [Project Outline](#project-outline)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 HTML, CSS and JavaScript Book List Storage Website

**[HTML, CSS and JavaScript Capstone]** is an HTML, CSS and JavaScript prject to showcase my HTML, CSS, JavaScript and GitHub Knowledge

## 🛠 Built With

1-HTML.
2-CSS.
3-JavaScript (5 & 6).
3-LINTERS.

### Tech Stack

HTML

CSS

JavaScript

Visual Code IDE / WebStorm IDE

### Key Features

- **JS with import/export and a Modules folder (modular architecture).**
- **A main class and its corresponding methods, and other functions to make the APP work.**
- **Reworked CSS Styling, UI improvements and UX (after inserting a book, it will move the user to the book list)**

(back to top)

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

### Prerequisites

1- Web browser
2- Code editor
3- Version Control System (git)

### Setup

Clone this repository to your desired folder:

Run this commands:

```sh
cd my-folder
git clone https://github.com/cancelei/Awesome-books.git
```

-

### Install

Install this project with:

Run this command:

```sh
cd Awesome-books
npm install
```

### Usage

To run the project, execute the following command:

```
launch index.html using live server or live preview
```

(back to top)

### Deployment

You can deploy this project using: Github Pages.

GitHub Pages allows you to host static websites directly from your GitHub repository.

To deploy this project using GitHub Pages, follow these steps:

Ensure that your project has a docs folder at the root directory. If it doesn't exist, create one and place all the necessary static files (HTML, CSS, JavaScript, etc.) inside this folder.

Push your code to a branch (e.g., main or master) in your GitHub repository.

Go to your GitHub repository's settings.

Scroll down to the GitHub Pages section.

In the "Source" drop-down menu, select the branch you want to deploy (e.g., main).

Select the /docs folder as the source.

Click on the "Save" or "Apply" button to save the changes.

GitHub Pages will build and deploy your project. Once the deployment process is completed, you will see a green success message along with the URL where your project is hosted.

Visit the provided URL to view your deployed project.

Please note that it may take a few moments for GitHub Pages to build and deploy your project. Additionally, ensure that your project is set up correctly with the necessary HTML, CSS, and JavaScript files in the docs folder for it to be deployed successfully.

(back to top)

## 👥 Authors

👤 **Muhammad Aminu Salihu**

- GitHub: [@mohashyne](https://github.com/mohashyne)
- Twitter: [@muhammadslyhu](https://twitter.com/muhammadslyhu)
- LinkedIn: [muhammad-salihu-27467a165](https://linkedin.com/in/muhammad-salihu-27467a165)

👤 **Glauber Bannwart**

- GitHub: [@cancelei](https://github.com/cancelei)
- LinkedIn: [gbannwart](https://linkedin.com/in/gbannwart/)

(back to top)

## 🔭 Future Features

- More Features, User Login, User Data Storage, Layout improvement.

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

## ⭐️ Show your support

If you like this project Please Rate IT!

(back to top)

## 🙏 Acknowledgments

I would like to acknowledge Mosh Hamedani for his great course on JavaScript.

(back to top)

## 📝 License

This project is [MIT](MIT.md) licensed.

(back to top)