Skip to content

Latest commit

 

History

History
103 lines (72 loc) · 2.98 KB

README.md

File metadata and controls

103 lines (72 loc) · 2.98 KB

Explore KZ

Overview and Purpose

Explore KZ is a comprehensive eCommerce application designed to simplify online order tours inside Kazakhstan. From browsing tour to checkout, it provides a seamless order experience for users. The purpose of this project is to create a user-friendly platform where customers can shop tours from the comfort of their homes.

Deploy

The working deploy is here

Video of deploy

We can't keep the deploy running. In case of server errors or any other circumstances you can watch the video below Recording video of a working deploy

Features

  • Tours Browsing: Browse through our extensive catalog of tours across multiple categories.
  • Search and Filter: Find exactly what you're looking for with our advanced search and filter options.
  • Order Cart: Add tour to your cart and manage them easily.
  • User Profile: Manage your profile, view orders.

Technology Stack

  • React
  • TypeScript
  • Vite
  • HTML
  • CSS
  • JEST
  • ESlint
  • Prettier
  • Husky

Setup Instructions

Follow these steps to set up and run the project locally:

Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js
  • npm
  • Git

Steps:

  • First, clone the repository to your local machine:
git clone https://github.com/sergiozeppo/ExploreKZ.git
  • Navigate into the cloned repository directory and install the project dependencies:
cd ExploreKZ
npm install
  • Running the App in Development Mode
npm run dev

The app will be running at http://localhost:5173

  • or Preview the built app, use the preview script:
npm run preview

This will run vite in preview mode, which simulates the deployment process on a server

  • To build the app, use the build script:
npm run build

Additional Scripts

Here are the available scripts and description for each of them:

  • npm run format - For automatic Prettier format code within /src directory
  • npm run ci:format - For Prettier checking code within /src directory
  • npm run lint - For ESlint checking
  • npm run lint:fix - For automatic ESlint fix within /src directory
  • npm run test - For start JEST tests
  • npm test -- --coverage - For start JEST test coverage checking

Contributors


sergiozeppo
ki8vi
iZeevens