shreyashkadam / bookify

An Online Audiobook Streaming Website

Bookify

An Online Audiobook Streaming Website made using MERN Stack, Tailwind CSS, Firebase for Google authentication and Storage, and Razorpay for Payment Integration

View Demo · Razorpay Test Cards (For testing payment gateway)

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Features
   • User Role
   • Admin Role
5. Contributing
6. Contact

About The Project

(back to top)

Built With

• React
• Express
• MongoDB
• Node
• Tailwind CSS
• Firebase
• Razorpay

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

1. Make sure you have latest version of npm installed
   • npm

     npm install npm@latest -g

2. Make sure you have your accounts set up on MongoDB, Firebase and Razorpay

Installation

1. Create project on Firebase and MongoDB
2. Make payment instance on Razorpay (preferably in Test Mode)
3. Get your API keys
   • Database String from MongoDB
   • Firebase Config keys from Firebase (Project Settings -> General)
   • Generate API Keys on Razorpay (Settings -> API Keys -> Generate API Keys)
4. Clone the repo

   git clone https://github.com/shreyashkadam/bookify.git

5. Install NPM packages

   npm install

6. Create .env file in both /client and /server folder
7. Copy the content from .example.env files in both /client and /server folder and paste it in the respective .env files created in step 6.
8. Fill your API keys in newly created .env files. (You shouldn't update variable names, just update the value)
9. Download private key from Firebase and rename it to serviceAccountKey.json (Project Setting -> Service Accounts -> Generate Private Key)
10. Put your serviceAccountKey.json in /server/config folder

(back to top)

Usage

1. Install packages and dependencies

   npm install

2. Start the server

   cd server/
   yarn dev

3. Start Client

   cd client/
   yarn start

(back to top)

Features

User Role

Payment Gateway

Audiobook Player

Search Filter

Login Page

Google Authentication

Admin Role

Admin Dashboard

Manage Users

Manage Audiobooks

Add Audiobooks

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Shreyash Kadam - @linkedin-handle - [e-mail]

Project Link: https://github.com/shreyashkadam/bookify

(back to top)