Skip to content

Latest commit

 

History

History
123 lines (82 loc) · 5.52 KB

README.md

File metadata and controls

123 lines (82 loc) · 5.52 KB
Raw

Book Corner

Book Corner is a full stack MERN application, an online bookstore where users can view books, sign up, and sign in to add/remove books to their wishlist, and add/remove books to their cart. It also includes a protected admin dashboard where admins can view books, and add, edit and remove a book, and view orders (UI) and customers (UI).


VIEW TABLE OF CONTENTS
  1. About the Project
  2. Technologies Used
  3. Developers
  4. Project Link
  5. Usage
  6. Acknowledgments

I. About the Project

Key Features:

User Management

  • User Registration: Sign up page.
  • User Authentication: Allow existing users to log in using their credentials.
  • User Profile: Users can view profile information, such as name and email.
  • Wishlist page: User can add and delete products from wishlist.

Book Management

  • Book Listing: Displays a list of books available in the bookstore on the shop page.
  • Search: Users can filter books searching by title or author.
  • Filter: Users can filter books by genre.
  • Sort: Users can alphabetically sort books by title or author .
  • Book Details: Users can view detailed information about each book, such as title, author, price, description, and image.

Shopping Cart and Checkout

  • Shopping Cart: Allows users to add books to their shopping cart. Users can change book quantity, and remove a book from the cart.
  • Checkout Process: Allow users to proceed to checkout.

Order Management

  • Order History: Users can view their past orders and order details.

Admin Dashboard

  • Book Management: Admins can add, edit, and delete books in the inventory. Manage book details such as title, author, description, price, and image.
  • Order Management: Admins can view orders (currently UI).
  • Customer Management: Admins can view customers (currently UI).

II. Languages and Tools Used

  • Mongodb
  • Express
  • Nodejs
  • React.js
  • TypeScript
  • Tailwind
  • Preline: Preline UI is an open-source set of prebuilt UI components based on the utility-first Tailwind CSS framework.
  • React Router: React Router is used for routing and navigation.
  • Apex Charts: ApexCharts.js is a library for creating interactive and customizable charts in JavaScript.
  • React Toastify: React Toastify is used for toasts.
  • Axios
  • Figma

III. Developers

V. Project Link

[https://book-corner.up.railway.app]

IV. Usage

Below is an example of how you can install and setup the application on your device.

To set up and run the Book Corner App locally, follow these steps:

  1. Clone this repository to your local machine:
[git clone https://github.com/chingu-voyages/v49-tier3-team-25.git]
  1. Change the directory to the project folder:
cd v49-tier3-team-25
  1. Install the project dependencies:
npm install
  1. Start the development server:
npm run dev
  1. Open your web browser and visit http://localhost:5173 to access Book Corner.

If you encounter any issues or have suggestions for improvements, please don't hesitate to create a GitHub issue or reach out to us.

V. Acknowledgments

Book info and covers from Open Library:

Figma Community Files: