diff --git a/README.md b/README.md index 9fe8812..1b8b388 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,60 @@ -
- -[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456 -[circleci-url]: https://circleci.com/gh/nestjs/nest - -A progressive Node.js framework for building efficient and scalable server-side applications.
- - - -## Description - -[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository. - -## Installation - -```bash -$ npm install -``` +# PlatziStore π -## Running the app +PlatziStore is a modern, responsive e-commerce web application built with Angular 19, TypeScript, and Tailwind CSS. It connects to the [Platzi Fake API](https://fakeapi.platzi.com/en/about/introduction) and provides full **CRUD** functionality for managing products. -```bash -# development -$ npm run start +> π **Live Demo:** [https://ssl-ecommerce.vercel.app](https://ssl-ecommerce.vercel.app) -# watch mode -$ npm run start:dev +--- -# production mode -$ npm run start:prod -``` +## β¨ Features + +- β List all products +- ποΈ View product details +- π Filter products by category +- π Search products by title +- β Create a new product +- βοΈ Update existing product +- β Delete product +- π Add/remove products from the shopping cart (with localStorage) +- β Real-time form validation +- π¨ Fully responsive UI with Tailwind CSS + +--- + +## π§° Tech Stack -## Test +| Tech | Description | +|-------------|--------------------------------------------| +| **Angular** | Angular 19 with standalone components | +| **TypeScript** | Strongly typed development | +| **Tailwind CSS** | Utility-first modern styling | +| **Platzi Fake API** | RESTful API for product data | +| **Vercel** | Deployment platform for the live site | -```bash -# unit tests -$ npm run test +--- -# e2e tests -$ npm run test:e2e +## Getting Started -# test coverage -$ npm run test:cov +### 1οΈβ£ Clone the Repository + +```sh +git clone https://github.com/mdsajalali/platzi-store.git +cd platzi-store ``` -## Support +### 2οΈβ£ Install Dependencies + +```sh +npm install +``` -Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support). +### 3οΈβ£ Run the Project -## Stay in touch +```sh +ng serve +``` -- Author - [Kamil MyΕliwiec](https://kamilmysliwiec.com) -- Website - [https://nestjs.com](https://nestjs.com/) -- Twitter - [@nestframework](https://twitter.com/nestframework) +The app will be available at **http://localhost:4200** π -## License +--- -Nest is [MIT licensed](LICENSE).