Skip to content

Commit

Permalink
Update: README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ClaytonSiby committed Oct 12, 2023
1 parent 3d5c465 commit 74e9f7a
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,27 @@
# helm_bookstore_app
Add books to a shelf, read later, edit the book information, and categorize your books.
<h4>
This is an MVP version of a bookstore where you can keep all your favorite books together in one easy to manage place. You can Add more books, View a book's details, Update a book's information, and Delete it from your collection. This version allows your to do all these functionalities with ease.
</h4>

**Cool dev tool**
**Application Functionality**

![App Functionality](/src/assets/images/helm_bookstore.gif)

<ins>**Application Setup Instructions**</ins>

<h6>Make sure you have the latest version of [Node](https://nodejs.org/en/) this instructions to setup and run the application on you local environment:</h6>

- `git clone https://github.com/ClaytonSiby/helm_bookstore_app.git` <br />
- `cd helm_bookstore_app` <br />
- `yarn install` <br />
- `yarn start` <br />

<ins>**Cool dev tool**</ins>

<h6>
This repository is setup to run a consistent default code format with Prettier and linting with Eslint. Before commit, lint-staged and Husky is ured run enforce these rules so that every commit adheres to the standards set for everyone contributing to the repository.
</h6>

**Application Functionality**

![App Functionality](/src/assets/images/helm_bookstore.gif)

**Husky and Lint-Stage Sample**
<ins>**Husky and Lint-Stage Sample**</ins>

![husky-lint](/src/assets/images/husky-lintstaged.png)

0 comments on commit 74e9f7a

Please sign in to comment.