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

https://github.com/jesusgraterol/library-top

This application enables users to add their favorite books to a library and it is the submission for The Odin Project: Library.
https://github.com/jesusgraterol/library-top

theodingproject theodinproject-nodejs theodinprojectfoundations

Last synced: about 2 months ago
JSON representation

This application enables users to add their favorite books to a library and it is the submission for The Odin Project: Library.

Awesome Lists containing this project

README

          

# Library

![Library](./readme-assets/screenshot-01.png)

This application enables users to add their favorite books to a library and it is the submission for [The Odin Project: Library](https://www.theodinproject.com/lessons/node-path-javascript-library). The key features are:

- Books and their essential information can be added
- The state of the books can be modified to separate the ones that have been already read
- The books can be deleted
- Cross-Platform Compatibility

## Live Demo

[Library](https://jesusgraterol.github.io/library-top/)

## Getting Started

### Requirements

- GIT
- Python ^v3

### Installation

1) Clone the repository
```bash
git clone git@github.com:jesusgraterol/library-top.git
```

## Usage

1) Run a local server with:

```bash
python3 -m http.server
```

2) Access the app through: [http://localhost:8000/](http://localhost:8000/)

## Build Process

N/A

## Deployment

Deploys to **Github Pages** automatically when commits are pushed into the `main` branch.

## Built With

- HTML5
- CSS3
- JavaScript

## Running the Tests

```bash
# Unit Tests
N/A

# Integration Tests
N/A

# E2E Tests
N/A
```

## @TODO

N/A

## License

[MIT](https://choosealicense.com/licenses/mit/)

## Acknowledgments

- [Google Fonts](https://fonts.google.com/icons)