Giter Club home page Giter Club logo

awesome-books-project's Introduction

logo

Awesome Books Project

Table of Contents ๐Ÿ“‹



Awesome Books ๐Ÿ“–

Awesome Books is a simple website application that displays a list of books and allows you to add and remove books from that list.


Built With ๐Ÿ› 

Tech Stack ๐Ÿ—œ๏ธ

Client
  • HTML5 markup to build raw structure of this web page

  • CSS3 custom properties, FlexBox, Grid to make the website visually attractive

  • Javascript

  • Linters for coding convention and coding formating
Javascript runtime environment
  • Node JS as a javascript runtime machine [git], a free and open source distributed version control system
Deployement



Key Features ๐Ÿท๏ธ

  • ES6 Implemntation with Modules
  • Manage books collection
  • Remove Books
  • Add Books

(back to top)



Live Demo ๐Ÿš€

(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:



Setup โš™๏ธ

Clone this repository to your desired folder:

cd my-folder
git clone https://github.com/RileyManda/awesome-books.git
  • Navigate to the folder
cd my-folder
  • Checkout the branch
git checkout main



Install ๐Ÿ—๏ธ

Install all dependencies:

    npm install



Usage ๐Ÿ“‚

To run the project, follow these instructions:

  • You have to clone this repo to your local machine.
git clone https://github.com/RileyManda/awesome-books.git



Run tests ๐Ÿงช

How should it be tested? To run tests, run the following command:

  • HTML linter errors run:
npx hint . --fix
  • CSS linter errors run:
npx stylelint "**/*.{css,scss}" --fix
  • JavaScript linter errors run:
npx eslint . --fix
  • For unit testing, run:
npm test



Deployment

You can deploy this project using: GitHub Pages, Vercel or Netlify.

This project was deployed using GitHub Pages. For more information about how to use GitHub pages read here ๐Ÿคฉ. If you want to watch a video about how to use GitHub pages instead of reading click here โ˜บ๏ธ.

(back to top)



๐Ÿ‘ฅ Authors

๐Ÿ‘ค Riley Manda

(back to top)



Future Features ๐Ÿ”ญ

  • Improve the UI with animations
  • Make the application responsive

(back to top)



๐Ÿ‘ฅ Attribution

Contributing ๐Ÿค

If you have suggestions ๐Ÿ“, ideas ๐Ÿค”, or bug reports ๐Ÿ›, please feel free to open an issue on GitHub. Remember, every contribution, no matter how big or small, makes a difference.

(back to top)



Show your support ๐ŸŒŸ

Thank you for taking the time to explore this project! Your support means a lot to me. If you find my project valuable and would like to contribute, here is one way you can support me:

  • Star the project โญ๏ธ: Show your appreciation by starring this GitHub repository. It helps increase visibility and lets others know that the project is well-received.

  • Fork the project ๐Ÿด ๐ŸŽฃ: If you're interested in making improvements or adding new features, feel free to fork the project. You can work on your own version and even submit pull requests to suggest changes.

  • Share with others ๐Ÿ—บ๏ธ: Spread the word about this project. Share it on social media, mention it in relevant forums or communities, or recommend it to colleagues and friends who might find it useful.

(back to top)



Acknowledgments ๐Ÿ™

I would like to express my sincere gratitude to Microverse, the dedicated reviewers, and collaborators. Your unwavering support, feedback, and collaborative efforts have played an immense role in making this journey a resounding success. I am truly grateful for your contributions and for being an integral part of my achievements. Thank you for your continued support.

(back to top)



FAQ โ“

  • Question_1 Do I have to use the vs code specifically?
    • Answer_1 You can use any code editor of your choice.
  • Question_2 Where can I download node JS for installation?

(back to top)

License ๐Ÿ“

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)

awesome-books-project's People

Contributors

rileymanda avatar

Stargazers

Andy Zamorano avatar

Watchers

 avatar

awesome-books-project's Issues

peer-to-peer code review

Status: Required changes
Good job so far but there are small things that you can still improve.
1.
peer to peer

I mention a miss of margin between the title and the author when the title is too long. Working on this would make your website looks better.

Luxon library

The Luxon library is not being recognized by gh pages when the application is hosted.

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.