My Books

My Books

📗 Table of Contents

• 📗 Table of Contents
• 📖 My Books
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ (OPTIONAL)
  • 📝 License

📖 My Books

"My books" is a website that displays a list of books and allows you to add and remove books from that list. By building this application, I learned how to manage data using JavaScript. Thanks to that my website is more interactive. I also used a medium-fidelity wireframe to build the UI.

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• JavaScript

Key Features

• A fully functional website.
• Mobile first website.
• Only using semantic HTML.

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

1. A web browser to see the website.

2. And a code editor if you want to edit the code. For example, Vs Code.

Setup

Clone this repository to your desired folder:

1. Clone it using your terminal:

git clone https://github.com/Alejandroq12/my-books.git

2. If the previous method does not work you may also download the repo as a .zip file and once you decompress the .zip file you are ready to use it.

Important: do not forget to clone the repo in the correct folder, probably you will use the following commands to achieve that in your terminal:

1. To navigate a certain folder:

cd <folder name>

2. To navigate to the previous folder:

cd ..

Install

Install this project with:

1. To see this project you will not need to install something else.

2. But in case you want to test the linter that I configured to check errors you will have to complete the following steps:

Run the command to install all necessary dependencies (including linters):

npm install

3. If you run npm install do not forget to create a .gitignore file to prevent the node_modules to be uploaded to GitHub:

.gitignore
node_modules/

Usage

To see this project you will only need to:

1. Open the index.html file with a web browser.

Run tests

1. Make sure all the linters and their configurations are installed and set up correctly in your project. If you haven't installed them yet, run npm install in your project directory to install the packages listed in your package.json file.

2. Run each linter with the following commands:

• For ESLint:

npx eslint .

• For Stylelint:

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

• For hint:

npx hint .

3. Review the output of each linter and fix any issues reported.

Deployment

You can deploy this project using GitHub pages:

1. Log in to your GitHub account and navigate to the repository that contains your website files.
2. Make sure that your website files are located in the main branch and in the root directory of the repository.
3. If your website is not already live, make sure that the index.html file is the main page of your website.
4. Click on the "Settings" tab in your repository.
5. Scroll down to the "GitHub Pages" section.
6. In the "Source" dropdown menu, select the branch where your website files are located. For a simple website with only HTML and CSS, this is typically the main branch.
7. In the "Path" field, make sure that the root directory is specified (i.e., "/").
8. Click "Save" to generate your website.
9. Wait a few minutes for GitHub to build and deploy your website.
10. Once the website is deployed, visit the GitHub Pages URL to view your site.

(back to top)

👥 Authors

👤 Julio Quezada

• GitHub: Alejandroq12
• Twitter: @JulioAle54
• LinkedIn: Julio Quezada

(back to top)

🔭 Future Features

• I will add a contact form
• I will add media queries for larger screens
• I will use JavaScript to add more

(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 give a star. Thanks in advance.

(back to top)

🙏 Acknowledgments

I would like to thank Wes Bos because I learned how to implement flexbox with his free tutorial:

• Wes Bos: Wes Bos

(back to top)

❓ FAQ (OPTIONAL)

• Are you goin to use React in the future?

  • Yes! I will transform this website into a React App.

• Did you create this website from scratch?

  • Yes! From zero, and I will improve it a lot.

(back to top)

📝 License

This project is MIT licensed.

(back to top)