Skip to content
/ kuku-FM Public

A code of web application that allows users to browse audiobooks, view details, and submit reviews and ratings.

Notifications You must be signed in to change notification settings

asqre/kuku-FM

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Audiobook Web Application

Project Overview

This web application allows users to browse audiobooks, view details, and submit reviews and ratings. It features a responsive front-end interface and a RESTful API backend.

Table of Contents

  1. Features
  2. Technology Stack
  3. Application Architecture
  4. API Usage
  5. Deployment Steps
  6. Getting Started

Features

  • Browse a list of audiobooks with basic details
  • Filter audiobooks by genre, author, and rating
  • View detailed information about individual audiobooks
  • Submit reviews and ratings for audiobooks

Technology Stack

Frontend

  • React.js
  • Tailwind CSS

Backend

  • Node.js
  • Express.js
  • MongoDB

Application Architecture

The application follows a client-server architecture:

  1. Frontend: A React application that provides the user interface. It communicates with the backend API to fetch and submit data.

  2. Backend: An Express.js server that handles API requests, interacts with the database, and serves data to the frontend.

  3. Database: MongoDB is used to store audiobook information, user reviews, and ratings.

API Usage

The backend provides the following RESTful API endpoints:

  • GET /api/audiobooks: Retrieve a list of audiobooks

  • GET /api/audiobooks/:id: Retrieve details of a specific audiobook

  • POST /api/reviews: Submit a new review

    • Body: { audiobookId, rating, review, userId }
  • GET /api/reviews/:audiobookId: Retrieve reviews for a specific audiobook

Deployment Steps

  1. Backend Deployment:

    • Set up a MongoDB database (e.g., MongoDB Atlas)
    • Deploy the Node.js application to a hosting service (e.g., Firebase, Heroku, DigitalOcean)
    • Set environment variables for database connection and other configurations
  2. Frontend Deployment:

    • Build the React application: yarn build
    • Deploy the built files to a static hosting service (e.g., Firebase, Netlify, Vercel)
    • Configure the deployed frontend to use the backend API URL

Screenshots

Here are some screenshots of the application:

Home Page

Home Page Browse audiobooks with filtering options

Audiobook Details

image View detailed information about an audiobook

Review Submission

image Submit a review for an audiobook

Login Modal

image

Live Demo

You can access a live demo of the application here: Audiobook Web App Demo

Getting Started

To run this project locally:

  1. Clone the repository

  2. Install dependencies in both client and server folder.

  3. Start the server.

    cd server
    yarn client

About

A code of web application that allows users to browse audiobooks, view details, and submit reviews and ratings.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published