Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://geekelo.github.io/awesome-books-webapp/
A basic website that allows users to add/remove books from a list
https://geekelo.github.io/awesome-books-webapp/
completed-project front-end-development javascript
Last synced: about 1 month ago
JSON representation
A basic website that allows users to add/remove books from a list
- Host: GitHub
- URL: https://geekelo.github.io/awesome-books-webapp/
- Owner: geekelo
- Created: 2023-06-06T20:25:53.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-01-13T03:25:04.000Z (6 months ago)
- Last Synced: 2024-05-22T20:03:41.038Z (about 2 months ago)
- Topics: completed-project, front-end-development, javascript
- Language: JavaScript
- Homepage:
- Size: 984 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Lists
- awesome-books-webapp - See Live Demo
README
# 📗 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](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
**The Awesome Books WebApp** is a user-friendly platform designed to help users keep track of their personal book collection. The website allows users to add and delete books from their record, making it convenient to manage their reading materials.
Users can easily add books to their collection by providing the book's title and author information. The website stores this data and displays it in an organized manner, making it easy for users to browse through their book records. Each book entry includes details such as the title and author, providing users with a comprehensive overview of their collection.
In addition to adding books, users can also remove books from their record when they no longer wish to track them. The website offers a simple deletion process, ensuring that users can effortlessly manage their collection over time.
The Awesome Books WebApp prioritizes user experience and provides a clean and intuitive interface. It offers a seamless process for adding and deleting books, empowering users to maintain an up-to-date and personalized record of their reading materials.
With the Awesome Books WebApp, users can effortlessly organize and track their book collection, ensuring they never lose sight of their favorite reads and enabling them to stay engaged with their literary adventures.
Head to the LIVE DEMO SECTION for Live links and presentations
ES6
HTML
CSS
JavaScript
- **Mobile Friendly** : this website performs well on a mobile device like a phone or tablet.
- **Desktop Friendly**: this website is responsive to desktop screen sizes.
- **Simple and Attractive Design** : the UI / UX is engaging and appealing.
- **Functional** : this website is accessible, easy to navigate, and helpful for users.
- **Animations and transitions : This website has engaging transitions and animations that makes it easier to use, smoother and more natural.
> View the live demo of this project by clicking the text below.
- [See Live Demo](https://geekelo.github.io/awesome-books-webapp/)
To get a local copy up and running, follow these steps.
> Clone the repository
```
git clone https://github.com/geekelo/awesome-books-webapp.git
```
> And you are ready to begin your project
### Setup
This project contains
An HTML FILE (free to edit) - file that contains html codes to give structure to the main webpage
A CSS FILE (free to edit) - file that contains css codes to style the webpage
A GIT IGNORE FILE (free to edit) - to hide personal or private files
HTML/CSS LINTER FILES (should not edit) - Do not make changes
A JAVASCRIPT FILE (free to edit) - that handles functionalities and dynamic HTML
### Prerequisites
> You should have Node and Git Installed
> You should have basic knowledge on HTML / CSS / JavaScript
> You should have a code editor
> Download install [VSCODE](https://code.visualstudio.com/) and [Git](https://git-scm.com/)
> To install linters, execute the following commands:
```
Initialize npm | ``` npminit -y ```
HTML | ``` npm install --save-dev [email protected] ```
CSS | ```npm install --save-dev [email protected] [email protected] [email protected] [email protected] ```
```
### Usage
To run the linters, execute the following command and fix linter errors:
```
HTML | ``` npx hint . ```
CSS | ```npx stylelint "**/*.{css,scss}" ```
If you get a flood of errors keep in mind that linters guide you in writing a clean code!
```
### Run Tests
You can run this program on your browser
You can deploy this project using the following procedure:
- Pick the right hosting provider.
- Choose the tool and method to upload your website.
- Upload files to your website.
- Move the website files to the main root folder.
- Import your database.
- Check if your website works worldwide.
👤 **Eloghene Otiede**
- GitHub: [@geekelo](https://github.com/geekelo)
- Twitter: [@Geekelo_xyz](https://twitter.com/Geekelo_xyz)
- LinkedIn: [LinkedIn](https://linkedin.com/in/eloghene-otiede)
- [See Documentation of Author's inputs](./Documentation/Geekelo-input.md)
You can offer Contributions, submit an [issue](../../issues/), and make a feature request.
- Add pop up modals
- Add the contact form
- Add more content pages
> Please give a ⭐️ to support this project
> Fonts: [Google Fonts](https://fonts.google.com/)
This project is [MIT](./MIT.md) licensed.