Skip to content

Latest commit

 

History

History
159 lines (100 loc) · 4.95 KB

README.md

File metadata and controls

159 lines (100 loc) · 4.95 KB

Re Books: Front-End Repository

Visit Website

Welcome to the front-end repository for Re Books — an innovative platform connecting individuals who wish to sell books from their personal libraries with those eager to purchase them. This application fosters a community-driven marketplace where users can list books for sale, browse available collections, and communicate seamlessly with each other.

This repository contains the React.js application code, which interfaces with our Back-End Repository.

Table of Contents

  1. Technologies Used
  2. Key Features
  3. Quick Start
  4. Presentation
  5. Authors

Technologies Used

Our front-end is powered by modern tools and libraries to ensure a smooth, efficient, and intuitive user experience:

  • Frameworks:

    • React - A JavaScript library for building user interfaces with a component-based architecture.

  • Routing and Navigation:

    • React Router Dom - Enables dynamic routing for an intuitive single-page application experience.

  • State Management:

    • React Context API - Manages global application state, such as user authentication, book data, and notifications.

  • HTTP Requests:

    • Axios - Handles API communication with the back-end server.

  • UI Components and Design:

    • Headless UI - Provides accessible and completely unstyled UI components, giving full control over styling and functionality.

  • Styling and CSS Frameworks:

    • Tailwind CSS - A utility-first CSS framework for responsive and modern UI design.

  • Development and Build Tools:

    • Vite - A fast front-end build tool for a streamlined development experience.
    • ESLint - Ensures consistent and clean code through linting.
    • Prettier - Formats code automatically for readability and uniformity.

Development Scripts

This project includes several NPM scripts to facilitate development, testing, and production builds:

  • start: Serves the production build from the dist directory.

    npm start

  • build: Builds the project for production.

    npm run build

  • format: Formats the codebase using Prettier.

    npm run format

  • lint: Lints the codebase using ESLint.

    npm run lint

  • preview: Serves the built application locally.

    npm run preview

Key Features

User Registration and Account Management

  • Sign Up: Users can register an account to buy and sell books.
  • Account Management: Users can provide detailed profile information and manage their listed and purchased books.
  • Dashboard: Displays sections for managing books in user's account.
  • Password Management: Allows users to reset or update their password.

Search, Filtering, and Sorting

  • Search Functionality: Search for books by title, author, or ISBN.
  • Filter Options: Narrow results by age category, genre, format, and condition.
  • Sorting and Pagination: Organize search results for easier browsing.

Book Viewing and Purchasing

  • List View: View all books that are available in stock.
  • Detailed Views: View book details, including cover, author, genre, price, and condition.
  • Purchase Books: Users can purchase books after logging in.

Communication System

  • Messaging: Real-time messaging using Socket.io. for immediate interaction between users regarding books.

Quick Start

Setup

  1. Clone the Repository: Clone this repository to your local machine.
  2. Install Dependencies: Run npm install to install required packages.
  3. Create a .env.local File: Create a .env.local file in the root directory and add the following variable:
  VITE_API_BASE_URL=http://localhost:8000
  1. Start the Development Server: Run npm run dev to start the application locally on localhost:5173.
  2. Explore the Application: Register an account and explore features such as book search, filtering, and messaging.

Additional Configuration

Presentation

Authors

  • Evgenii Rychkov
  • Brandon Warren
  • Liuba Barusch