mohamadabdelhady/intellect_book_service_website

A subscription-based service, that allow user to read and listen to a big collection of e-books, audio books, magazine and podcast in exchange of subscription.

About the project

Intellect book service is subscription based website for reading e-books and listening to audiobooks, users of the website can enjoy reading and listening to books online for small subscription fee, users can also read reviews left by other users of the website as well as leaving their own, once the user signup they can enjoy 30 days trial of the website after it end the user can choose one of the three subscription plan put on the main page.

preview of the website

Screenshots

video tour of the website

What is this website built with

• Front-end
  • HTML/CSS/Bootstrap
  • JavaScript( Vue.js )
  • epub.js( JavaScript library for rendering ePub documents in the browser, across many devices.)
  • Howler.js( JavaScript library for playing audio on a website)
• Back-end
  • PHP( Laravel )
  • Laravel packages used in this project ( Laravel fortify, Laravel Socialite )
  • MySql

How to set up the project after cloning it

1. Make sure that you installed npm and composer
2. Open command line inside the project
3. type "composer install"
4. type "npm install"
5. type "cp .env.example .env"
6. type "php artisan key:generate"
7. Creat a database with the same name of the same name as "DB_DATABASE" field in .env file
8. type "php artisan migrate"
9. To run the project on your browser type "php artisan serve"
10. To put test data into the database type "query" into the url

How to use the website

• After opening the home page click the signup button which will take to signup page
• You can sign up wit your username, email and password or with your google account
• After signing up successfully you will have 30 days to use the website before it asks you to choose a subscription plane
• After signing up the main page will open, and you will find two section one for e-books and another for audiobooks, a nav bar which contain a search bar, a user menu and side nav-bar triggered by click tha burger button beside the website logo.
• If you clicked on either the e-books and audiobooks, it will take to another page to check the description of the book, the reviews, a button to read/listen to the book and another to added to your bookmark list.
• If you clicked on the read button it will take to a page with the book in the center of it and the navigation tools on the left and the bottom of it, if you closed the page or went to another page your progress on the book will be saved.
• If you clicked on the listen button it will take to a page with an audio player to listen to the audiobook you clicked on, if you closed the page or went to another one your progress on the audiobook will be saved.
• You can use the user menu to go to your bookmark list, got to your settings or log out.

Notes

• I didn't implement a way to add a payment method, so if you are planning to use this project in commercial use you will have to implement one.
• If you run the project using "php artisan serve" the audioplayer will play from the begining when you stop it and play it again, but don't worry this error occuor only on the local larave development but it work perfectly fine on apache server.

Licence

Intellect book service website is open-sourced software licensed under the MIT licence.