Up´date readme

midudev · Sep 19, 2023 · d9682ff · d9682ff
1 parent 3295ba5
commit d9682ff
Showing 1 changed file with 57 additions and 43 deletions.
diff --git a/pruebas/02-bazar-universal/fernandochaza/simple-shop/README.md b/pruebas/02-bazar-universal/fernandochaza/simple-shop/README.md
@@ -1,35 +1,45 @@
 # Simple Shop
 
-Welcome! 👋
+**Welcome! 👋**
 
-This is a <b>Next JS</b> web application that simulates an e-commerce find-and-buy experience.  
+This is a **Next JS** web application that simulates an e-commerce find-and-buy experience.  
 
-I made it to practice my Web Developer skills and to gain proficiency in the used technologies
+I made it to practice my Web Developer skills and to gain proficiency in the used technologies 
 
-\* I'm not following any tutorial or predefined design system
+\* *This is an original project. I'm not following any tutorial or predefined design system.*
 
-### Performance
+## Performance
 ![Website performance metrics](docs/screenshots/performance.png)
 
-### Clean Code. Solid Architecture
+## Clean Code. Solid Architecture
 ✔ No ESLint warnings or errors  
 ✔ Maintainable and Scalable project and components architecture
 
-### Views
+## Views
 ![Screenshots of mobile views](docs/screenshots/3views.png)
 
-*** IMPORTANT: The site is optimized for mobile device screens ***
+**IMPORTANT: The site is optimized for mobile device screens**  
+<br>
+
+<details>
+<summary style="font-size: 20px">Built with</summary>
+<br>  
 
-## Built with
 - [React](https://reactjs.org/)
 - [Next.JS 13](https://nextjs.org/docs/app) - Using the brand new App Router paradigm
 - [Typescript](https://www.typescriptlang.org/)
 - [Tailwind CSS](https://tailwindcss.com/)
 - [React Hook Form](https://react-hook-form.com/)
 - [Auto Animate](https://auto-animate.formkit.com/) - For subtle animations
-- [Vercel](https://vercel.com/)
+- [Vercel](https://vercel.com/)  
+<br>
+</details>
+
+
+<details>
+<summary style="font-size: 20px">Development roadmap</summary>
+<br>
 
-## Development roadmap
 &nbsp;&nbsp; &#9745; Prepare environment  
 &nbsp;&nbsp; &#9745; Create and clean-up Next.JS project  
 &nbsp;&nbsp; &#9745; Configure main layout (Fonts, Metadata for SEO)  
@@ -42,62 +52,66 @@ I made it to practice my Web Developer skills and to gain proficiency in the use
 &nbsp;&nbsp; &#9745; Add simple transitions to improve UI  
 &nbsp;&nbsp; &#9745; Create endpoints for products searching using route.ts inside API route  
 &nbsp;&nbsp; &#9745; Check accessibility (aria labels, contrast issues)  
-&nbsp;&nbsp; &#9745; Optimize for performance (images, fonts preloading)  
+&nbsp;&nbsp; &#9745; Optimize for performance (es, fonts preloading)  
 &nbsp;&nbsp; &#9745; Check and fix linter suggestions  
 &nbsp;&nbsp; &#9745; Deploy on Vercel  
 &nbsp;&nbsp; &#9745; Create Readme  
+<br>
+
+</details>
+
+<details>
+<summary style="font-size: 20px">ToDos</summary>
+<br>
 
-## TODOS
 &nbsp;&nbsp; &#9744; Add end-to-end testing  
 &nbsp;&nbsp; &#9744; Add media queries  
 &nbsp;&nbsp; &#9744; Add skeletons on loading  
 &nbsp;&nbsp; &#9744; Improve error handling and error displaying  
+<br>
 
-## Live Demo
-Check out and test the live demo of the application:  
-### Production: [Simple Shop](https://simple-shop-nine.vercel.app/)
+</details>
 
-** Please, feel free to reach out to me if you have any suggestions **
-
-## Let's talk!
+<details>
+<summary style="font-size: 20px">Live Demo</summary>
+<br>
 
-* Email: fernandochaza@gmail.com
-* Phone: +5492974607698
-* Whatsapp Me: [Click to chat](https://wa.me/5492974607698) 
-* My discord: [Go to Discord](https://discord.com/users/413889897909321729)
-* LinkedIn profile: https://www.linkedin.com/in/fernandochazarreta/
+Check out and test the live demo of the application: [Simple Shop](https://simple-shop-nine.vercel.app/)
 
-## Want to run it locally?
+** Please, feel free to reach out to me if you have any suggestions **
 
-Follow these steps:
 <br>
 
-1. Clone the repository.
+</details>
 
-```bash
-git clone https://github.com/fernandochaza/pruebas-tecnicas.git
-```
 
+<details>
+<summary style="font-size: 20px">Want to run it locally?</summary>
 <br>
+Follow these steps:
 
-2. Access the project folder.
+1. Clone the repository.
+   - `git clone https://github.com/fernandochaza/pruebas-tecnicas.git`  
 
-- The project files are in a subdirectory. You will need to access it before installing the dependencies.
-- The directory is: `02-bazar-universal/fernandochaza/simple-shop` 
 
-<br>
+2. Access the project folder.
+   - The project files are in a subdirectory. You will need to access it before installing the dependencies.
+   - The directory is: `02-bazar-universal/fernandochaza/simple-shop` 
 
 3. Install dependencies.
 
-- Once you're in 'simple-shop' directory, run:
-```bash
-npm install
-```
+   - Once you're in 'simple-shop' directory, run: 
+     - `npm install`
 
-<br>
+4. Start the development server with: 
+   - `npm run dev`
 
+</details>
 
-4. Start the development server.
-```bash
-npm run dev
-```
+## Let's talk!
+
+* Email: fernandochaza@gmail.com
+* Phone: +5492974607698
+* Whatsapp: [Click to chat](https://wa.me/5492974607698) 
+* Discord: [Contact on Discord](https://discord.com/users/413889897909321729)
+* LinkedIn : [See my LinkedIn profile](https://www.linkedin.com/in/fernandochazarreta/)