/Awesome-Books

Awesome Books is a basic website that allows users to add/remove books from a list. This project is achieved by JavaScript objects and arrays. But also I dynamically modify the DOM and add basic events.

Primary LanguageJavaScript

Project Name : Awesome Books

Awesome Books is a basic website that allows users to add/remove books from a list. This project is achieved by JavaScript objects and arrays. But also I dynamically modify the DOM and add basic events.

In order to achieve this project I used some resources and technologies listed below :

On Desktop On Mobile
Desktop version of the project Mobile Version

Built With

  • Major languages : JavaScript Object & HTLM
  • Frameworks : none
  • Technologies used : Github, Git and Linters

Live Demo

Click here for the demo

Getting Started

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

Prerequisites ♻️

  • A personal computer connected to the internet;
  • Have a working and updated browser.
  • Have a local version control like git installed on your computer
  • Have an account on Github, as an online/remote Version Control System
  • Code editor (Visual studio code, sublime text, notepad++, ...) installed on your computer;
  • At least basic of HTML and CSS.

Setup 🎰

  • Click the me and you'll land on the pure repository;
  • click on the green (🟢) button with Code Inscription;
  • You can choose to download the project or just clone it if you are familiar with Git and Github;
  • Follow normal step once download in your computer and use it as it's yours.

Install

  • If you are familiar with git, Run npm install to get all dependecies required to run the linters checks, otherwise use the downloaded project on your computer without testing files

Run test 🧪

Run thes command bellow inside your git bash or command line interface.

  • npx hint . : for the html codebase and use of best practices.
  • npx stylelint "**/*.{css,scss}" : for the css codebase and use of best practices. you can add
  • npx eslint . : for the JavaScript codebase and use of best practices.

  • Note that you can add --fix keyword to the command for Css and/or JavaScript to make sure that you avoid all errors comming from your code editor

Author

👤 Chris Siku (Main Author)

Chris Siku's GitHub stats

👤 Shaquille Ndunda (Coding partner)

Shaquille Ndunda's GitHub stats

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

  • Microverse
  • Hat tip to anyone whose code was used.

📝 License

This project is MIT licensed.