Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://bestbynature.github.io/awesome-books-project/

This is a basic website that allows users to add or remove books from a list.
https://bestbynature.github.io/awesome-books-project/

Last synced: about 2 months ago
JSON representation

This is a basic website that allows users to add or remove books from a list.

Awesome Lists containing this project

README 

        





  

  



  
Awesome Books Project






# 📗 Table of Contents



- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)



# 📖 [Awesome Books Project] 



**[Awesome Books Project](https://bestbynature.github.io/awesome-books-project/)** is a  a basic website that allows users to add and/or remove books from a list of books on the website. The Project is achieved by using JavaScript objects and arrays. The project also implemented features that dynamically modify the DOM and add basic events and listeners..



## 🛠 Built With 



### Tech Stack 



  Client

  
    

        
  • HTML
    • 

        
  • CSS
    • 

        
  • JAVASCRIPT
    • 

      



### Key Features 



- **[Responsive design]**

- **[Page Jumps]**

- **[Add/Remove buttons]**



(back to top)



## 🚀 Live Demo 



- [Awesome Books Project](https://bestbynature.github.io/awesome-books-project/)



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

    

        
  • The current version of node
    • 

        
  • To have Git installed on your local machine
    • 

        
  • Node Package manager (npm) 
    • 

        
  • An editor such as Visual Studio Code
    • 

      



### Setup



Clone this repository to your desired folder:

    

        
  • Create your classic access token from github.com
    • 

        
  • run "git clone https://{access_token}@github.com/username/{repo_name}.git"
    • 

        
  • Update your git identity by running "git config --global user.email "[email protected]""
    • 

        
  • Update your name on git by running "git config --global user.name "your_name"
    • 

      



### Install



Install this project with:



- In the first commit of your feature branch create a .github/workflows folder and add a copy of [.github/workflows/linters.yml](https://github.com/microverseinc/linters-config/blob/master/html-css-js/.github/workflows/linters.yml) to that folder.

- create a .gitignore file and add 'node_modules' to it

- run 'npm init -y'

- run 'npm install --save-dev [email protected]'

- Copy [hintrc](https://github.com/microverseinc/linters-config/blob/master/html-css-js/.hintrc) to the root directory of your project.

- run 'npx hint .'

- Fix validation errors.

- run 'npm install --save-dev [email protected] [email protected] [email protected] [email protected]'

- Copy [stylelintrc.json](https://github.com/microverseinc/linters-config/blob/master/html-css-js/.stylelintrc.json) to the root directory of your project.

- Run 'npx stylelint "**/*.{css,scss}"'

- fix linter errors

- run 'npm install --save-dev [email protected] [email protected] [email protected] [email protected]'

- Copy [eslintrc.json](https://github.com/microverseinc/linters-config/tree/master/html-css-js)

- Run npx eslint . on the root of your directory of your project

- Fix linter error.



### Usage



To run the project, execute the following command:



```sh

  use git bash to open in Vs code

```



### Run tests



To run tests, run the following command:



```sh

Run "npx hint ." 

Run "npx stylelint "**/*.{css,scss} --fix " to fix linters 

Run "npx eslint . --fix to fix linters"

```



  ### Deployment



You can deploy this project using:



- github pages



(back to top)



## 👥 Authors 



👤 **Author1**



- GitHub: [@githubhandle](https://github.com/Bestbynature)

- Twitter: [@twitterhandle](https://twitter.com/Dammybest)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/damilare-ismaila-4a5a8b30/)



**Author2**

- GitHub: [Abdi Bekele](https://github.com/Lul-Abdifan)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/abdi-bekele-a63860254/)

- e-mail: [[email protected]](mailto:[email protected])



(back to top)



## 🔭 Future Features 



- [ ] **[contact form page]**

- [ ] **[A feature for price inclusion]**

- [ ] **[A feature for updating the cart]**



(back to top)



## 🤝 Contributing 



Contributions, issues, and feature requests are welcome!



Feel free to check the [issues page](../../issues/).



(back to top)



## ⭐️ Show your support 



If you like this project, kindly drop a star for me.



(back to top)



## 🙏 Acknowledgments 



I would like to use this medium to appreciate [My coding partner](https://github.com/Lul-Abdifan) for brainstorming together with me.



(back to top)



## 📝 License 



This project is [MIT](./LICENSE) licensed.



(back to top)