/Online-Store-Frontend

E-shop for educational purposes (Frontend)

Primary LanguageTypeScriptMIT LicenseMIT

Iced-Latte (Frontend)

ci Status license Known Vulnerabilities Docker Pulls GitHub issues GitHub stars

Iced-Latte (Frontend) is a frontend that simulates the operations of an coffee online shop. Built using Next.js, it's crafted for educational purposes, offering insights into modern application development with Next.js.

Table of Contents

Tech Stack

  • Core: Next.js + Typescript.
  • State manager: Zustand.
  • Css framework: TailwindCSS.
  • Testing: Jest, React-Testing-Library.

Quick Start

Follow the setup instructions in START.MD to get the project up and running.

Features

  • User Authentication and Authorization
  • Product Catalog Management
  • Order Processing and Tracking
  • Stripe Payment Integration
  • Real-time Data Monitoring

API Documentation

The API is fully documented with Swagger. Access the documentation at http://localhost:8083/api/docs/swagger-ui once the server is running.

Project structure

  - public/  (static files)
  - src/  (sources directory)
    - app/
      - _components/  (components used by current page)
      - someRouteFolder/  (some rote page)
        - _components/  (someRoute page components)
        page.tsx  (someRoute page)
      globals.css  (global styles)
      layout.tsx  (root layout)
      page.tsx  (main page)
    - components  (shared components across application)
      - ui  (shared ui components (buttons, etc.))
    - constants  (temporary hardcoded values)
    - data  (temporary mocked data)
    - hooks  (custom hooks)
    - models  (typescript types)
    - services
    - utils  (utility functions)
    tailwind.config.ts  (tailwind custom classes)

Contributing

Interested in contributing? Read our Contributing Guide for details on our code of conduct and the process for submitting pull requests.

Code of Conduct

Please read our Code of Conduct to keep our community approachable and respectable.

License

This project is licensed under the MIT License.

Contact

Have any questions or suggestions? Feel free to open an issue or contact us directly.

FAQ

Address some common questions users might have about your project.

  1. Question: How do I set up the project? Answer: Follow the instructions in START.MD.

  2. Question: Where can I find API documentation? Answer: The API documentation is available at http://localhost:8083/api/docs/swagger-ui.

Community and Support

Join our community https://t.me/zufarexplained! Link to forums, chat, or community pages if available.