/Verdantis

Primary LanguageTypeScript


Verdantis

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing

About The Project

Learning project from the course The Rolling Scopes School JavaScript/Front-end

Completed: May 2024

Verdantis - online plants store

Team project by Kate, Nastya, and Den

Users can browse through a vast range of products, view detailed descriptions, add their favorite items to the basket, and proceed to checkout . It includes features such as user registration and login, product search, product categorization, and sorting to make the shopping experience more streamlined and convenient.

An important aspect of our application is that it's responsive, ensuring it looks great on various devices with a minimum resolution of 320px. This feature makes the shopping experience enjoyable, irrespective of the device users prefer.

Link to task from RS School

Functionality

  • Application is SPA
  • Product cards
  • Products by category
  • Registration and login
  • Basket for goods
  • User Profile

Technology stack

  • NPM
  • HTML5
  • TypeScript
  • Prettier
  • Stylelint
  • Lint-staged
  • Husky
  • Eslint
  • Tailwind
  • Mui
  • React
  • React-hook-form
  • Zod
  • Testing-Library
  • Vitest
  • Zustand
  • Vite
  • Netlify

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

Below is an example of how to install and configure the application.

  1. Clone the repo

    sh git clone https://github.com/KateGoncharik/eCommerce-Application-Q4.git

  2. Install NPM packages

    sh npm install

  3. Start project

    sh npm run start

(back to top)

Usage

Available scripts:

npm run dev

Start local development server

npm run build

Build project in production mode for further deployment

npm run format:fix

Reformat source code & configs to match Prettier settings

npm run lint

Check source code with ESLint. Exit with non-zero return code after the first found warning (useful for CI/CD)

npm run lint:fix

Automatically fix all auto-fixable errors & warnings with ESLint

npm run typecheck

Perform TypeScript typechecking of source code with tsc (TypeScript Compiler)

npm run preview

Locally preview the production build

npm run prepare

Runs automatically after package installation to install Husky hooks

npm run test

Runs tests with Vitest

npm run coverage

Displays coverage of implemented tests

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/...)
  3. Commit your Changes (git commit -m 'Add some ...')
  4. Push to the Branch (git push)
  5. Open a Pull Request

(back to top)