Skip to content

Commit

Permalink
Merge pull request #7 from HenestrosaDev/dev
Browse files Browse the repository at this point in the history
Add `youtube-thumbnail.png` to the README
  • Loading branch information
HenestrosaDev authored Jun 14, 2024
2 parents eeeea60 + 6f795c5 commit 34e0b78
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,9 @@

## About the Project

[![Presentation video](/docs/common/youtube-thumbnail.png)](https://youtu.be/nN5XyJb1UYE)
>Video in Spanish with English subtitles explaining the main features of the website.
**The Wordsmith's Collection** consists of a website with a subscription model (SaaS) that allows users to access a curated library of the most important literary works in history. They will be able to read the books on the site, as well as search and filter by genre and author. Each book, genre and author will have a description to get more insight into their bibliography and synopsis, respectively.

In order to access the service, users must register and enter a credit card for payment. Note that no payments are actually made, as the site only verifies that the credit card is valid. To actually use this feature, you should implement a payment gateway provider such as Redsys or Stripe.
Expand All @@ -107,7 +110,7 @@ The website has three types of users:
- **Subscriber**: Registered user who pays a monthly/annual fee to read books. Can be **Basic** or **Premium**.
- **Administrator**: An existing user who, in addition to performing the same operations as a subscriber, can add, edit, and delete books at will.

<details open>
<details>
<summary>Screenshots</summary>

<p align="center">
Expand Down Expand Up @@ -137,9 +140,9 @@ The website has three types of users:
<p align="center">
<img
width="49%"
src="https://github.com/HenestrosaDev/the-wordsmiths-collection/blob/main/docs/en/screenshots/book-read.png"
alt="Book reader"
title="Book reader"
src="https://github.com/HenestrosaDev/the-wordsmiths-collection/blob/main/docs/en/screenshots/profile-edit.png"
alt="Profile edit"
title="Profile edit"
>
&nbsp;
<img
Expand Down Expand Up @@ -167,11 +170,11 @@ The website has three types of users:
</p>

<p align="center">
<img
<img
width="49%"
src="https://github.com/HenestrosaDev/the-wordsmiths-collection/blob/main/docs/en/screenshots/profile-edit.png"
alt="Profile edit"
title="Profile edit"
src="https://github.com/HenestrosaDev/the-wordsmiths-collection/blob/main/docs/en/screenshots/book-read.png"
alt="Book reader"
title="Book reader"
>
</p>
<br>
Expand All @@ -185,8 +188,9 @@ The website has three types of users:
- [TailwindCSS](https://tailwindcss.com/docs/guides/laravel): CSS framework.
- [Vue.js 3](https://vuejs.org/): JavaScript framework.
- [Inertia.js](https://inertiajs.com/): Enables the creation of fully client-side rendered, single-page applications without the complexity of modern SPAs.
- [drawio.com](drawio.com): Tool used to create the diagrams.
- [drawio.com](https://drawio.com): Tool used to create the diagrams.
- [Flowbite](https://flowbite.com): Open-source UI component library built on top of Tailwind CSS. Used for Nav dropdowns and tabs.
- [PDF.js](https://mozilla.github.io/pdf.js/): Library for rendering PDFs.
- [Spatie/laravel-medialibrary](https://spatie.be/docs/laravel-medialibrary/v11/introduction): Associates files with Eloquent models.
- [uuid](https://www.npmjs.com/package/uuid): JavaScript package to generate unique UUIDs for the alerts.
- [cviebrock/eloquent-sluggable](https://github.com/cviebrock/eloquent-sluggable): Creates unique slugs for Eloquent models in Laravel.
Expand Down
Binary file added docs/common/youtube-thumbnail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 34e0b78

Please sign in to comment.