Skip to content

SkullShoT007/ReadPoint

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

5 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“š ReadPoint - eBook Marketplace

A modern, responsive eBook marketplace built with React that allows users to browse, search, and purchase educational courses and eBooks. Built with a focus on user experience and modern web development practices.

ReadPoint Tailwind CSS License

✨ Features

  • πŸ“– eBook Catalog: Browse through a comprehensive collection of educational courses and eBooks
  • πŸ” Advanced Search: Search products by title, category, and other filters
  • πŸ›’ Shopping Cart: Add items to cart and manage your purchases
  • πŸ‘€ User Authentication: Secure login and registration system
  • πŸ“± Responsive Design: Optimized for desktop, tablet, and mobile devices
  • πŸŒ™ Dark Mode: Toggle between light and dark themes
  • ⭐ Product Ratings: View and filter products by ratings
  • πŸ’³ Order Management: Track your orders and purchase history
  • 🎨 Modern UI: Beautiful, intuitive interface built with Tailwind CSS

πŸš€ Tech Stack

  • Frontend: React 19.1.0
  • Routing: React Router DOM 7.6.2
  • Styling: Tailwind CSS 3.4.17
  • State Management: React Context API
  • Backend: JSON Server with authentication
  • Notifications: React Toastify
  • Testing: React Testing Library

πŸ“¦ Installation

  1. Clone the repository

    git clone https://github.com/yourusername/readpoint.git
    cd readpoint
  2. Install dependencies

    npm install
  3. Set up the backend server

    # Install JSON Server globally (if not already installed)
    npm install -g json-server
    
    # Start the backend server
    json-server --watch data/db.json --port 8000
  4. Start the development server

    npm start
  5. Open your browser Navigate to http://localhost:3000 to view the application.

πŸ—οΈ Project Structure

readpoint/
β”œβ”€β”€ public/                 # Static assets
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ components/         # Reusable UI components
β”‚   β”‚   β”œβ”€β”€ elements/       # Basic UI elements
β”‚   β”‚   β”œβ”€β”€ layouts/        # Layout components
β”‚   β”‚   └── other/          # Other components
β”‚   β”œβ”€β”€ pages/              # Page components
β”‚   β”‚   β”œβ”€β”€ home/           # Homepage components
β”‚   β”‚   β”œβ”€β”€ products/       # Product listing and details
β”‚   β”‚   β”œβ”€β”€ cart/           # Shopping cart functionality
β”‚   β”‚   β”œβ”€β”€ order/          # Order management
β”‚   β”‚   └── dashboard/      # User dashboard
β”‚   β”œβ”€β”€ context/            # React Context providers
β”‚   β”œβ”€β”€ hooks/              # Custom React hooks
β”‚   β”œβ”€β”€ services/           # API service functions
β”‚   β”œβ”€β”€ reducers/           # State reducers
β”‚   └── routes/             # Routing configuration
β”œβ”€β”€ data/
β”‚   β”œβ”€β”€ db.json            # JSON Server database
β”‚   └── routes.json        # API route configuration
└── tailwind.config.js     # Tailwind CSS configuration

🎯 Key Features Explained

Product Catalog

  • Browse through a curated collection of educational eBooks and courses
  • Filter products by price, rating, availability, and best-seller status
  • Detailed product pages with comprehensive information

User Authentication

  • Secure login and registration system
  • Protected routes for authenticated users
  • User profile management

Shopping Experience

  • Add products to cart with quantity management
  • Secure checkout process
  • Order tracking and history

Search & Filter

  • Real-time search functionality
  • Advanced filtering options
  • Responsive search results

πŸ› οΈ Available Scripts

  • npm start - Runs the app in development mode
  • npm test - Launches the test runner
  • npm run build - Builds the app for production
  • npm run eject - Ejects from Create React App (one-way operation)

πŸ”§ Configuration

Environment Variables

Create a .env file in the root directory:

REACT_APP_API_URL=http://localhost:8000

Tailwind CSS

The project uses Tailwind CSS with custom color scheme:

  • customBlack: #3a3a3a
  • customWhite: #ffffff
  • customBackground: #232428
  • customCard: #1A1A1D

πŸ“Š API Endpoints

The application uses JSON Server with the following endpoints:

  • GET /products - Get all products
  • GET /products/:id - Get specific product
  • GET /featured_products - Get featured products
  • POST /orders - Create new order
  • GET /orders - Get user orders
  • POST /users - User registration
  • POST /login - User authentication

πŸ§ͺ Testing

Run the test suite:

npm test

πŸ“± Browser Support

  • Chrome (latest)
  • Firefox (latest)
  • Safari (latest)
  • Edge (latest)

🀝 Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ™ Acknowledgments

πŸ“ž Support

If you have any questions or need help, please open an issue in the GitHub repository.


Happy Reading! πŸ“šβœ¨

About

A modern, responsive eBook marketplace built with React that allows users to browse, search, and purchase educational courses and eBooks. Features include user authentication, shopping cart functionality, dark mode, and a beautiful UI built with Tailwind CSS.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors