Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Update all documentation.
  • Loading branch information
ITurres authored Aug 8, 2023
1 parent c342499 commit eb0afcd
Showing 1 changed file with 136 additions and 42 deletions.
178 changes: 136 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,69 +1,119 @@
<a name="readme-top"></a>

<div align="center">
<a href="">
<img alt="the time meister logo" src="/src/assets/media/img/logo/ttm-short-logo-white.png" width="70">
</a>
<img src="/src/assets/media/img/logo/ttm-logo-color.png" alt="logo" width="320" height="auto" />
<h1><b>The Time Meister | Watch Website</b></h1>
</div>
<h1 align="center">The Time Meister | E-commerce Watch Website</h1>

### Check it out! [The Time Meister](https://iturres.github.io/ttm-e-commerce/)
---

<!-- TABLE OF CONTENTS -->

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)

### TOPIC: _Watches_
---

### PARTIAL CLONE OF: https://www.rolex.com/ (November 2022 version)
<!-- PROJECT DESCRIPTION -->

### PURPOSE OF CHALLENGE:
# 📖 The Time Meister <a name="about-project"></a>

- The primary objective of this project was to translate provided wireframes and styles into an e-commerce website, complete with multiple pages catering to various user roles, including administrators and clients. Remarkably, this was achieved with just three HTML files, showcasing an efficient and streamlined approach to web development.

- #### Create a Client page side.
- #### Create an Administrators page side.
- #### Introduce CRUD.
- #### Load data on templates and inject them within the main markup.
- #### Reuse a single HTML file for different web pages (each watch page).
- #### Store data across different web pages and reuse it.
- #### Get familiar with JSON.
- #### Keep up with Markup and Styles.
- #### Continue practising JavaScript.
- ### PARTIAL CLONE OF: https://www.rolex.com/ (November 2022 version)

---

### Style Approach:
#### Learning objectives

- Create a Client page side.
- Create an Administrators page side.
- Introduce CRUD.
- Load data on templates and inject them within the main markup.
- Reuse a single HTML file for different web pages (each watch page).
- Store data across different web pages and reuse it.
- Get familiar with JSON.
- Keep up with Markup and Styles.
- Continue practising JavaScript.

## 🛠 Built With <a name="built-with"></a>

### Tech Stack <a name="tech-stack"></a>

<ul>
<li>
<img src="https://skillicons.dev/icons?i=nodejs"/>
<a href="https://nodejs.org/en">Node.js</a>
</li>
<li>
<img src="https://skillicons.dev/icons?i=js"/>
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript">JavaScript</a>
</li>
<li>
<img src="https://skillicons.dev/icons?i=css"/>
<a href="[https://sass-lang.com/](https://developer.mozilla.org/en-US/docs/Web/CSS)">CSS</a>
</li>
<li>
<img src="https://skillicons.dev/icons?i=html"/>
<a href="https://developer.mozilla.org/en-US/docs/Web/HTML">HTML</a>
</li>
</ul>

### Libraries used:

- #### Mobile First.
- #### [UUID](https://cdnjs.com/libraries/uuid/8.3.2)

### Responsive:
<p align="right">(<a href="#readme-top">back to top</a>)</p>

- #### Yes.
---

### Built with:
<!-- LIVE DEMO -->

[![My Skills](https://skillicons.dev/icons?i=html)](https://skillicons.dev)
[![My Skills](https://skillicons.dev/icons?i=css)](https://skillicons.dev)
[![My Skills](https://skillicons.dev/icons?i=js)](https://skillicons.dev)
[![My Skills](https://skillicons.dev/icons?i=nodejs)](https://skillicons.dev)
## 🚀 Live Demo <a name="live-demo"></a>

### Libraries used:
- [TTM - Live Demo Link](https://iturres.github.io/ttm-e-commerce/)

- #### [UUID](https://cdnjs.com/libraries/uuid/8.3.2)
<p align="right">(<a href="#readme-top">back to top</a>)</p>

---

### Frameworks:
<!-- GETTING STARTED -->

- #### none.
## 💻 Getting Started <a name="getting-started"></a>

---
To get a local copy up and running, follow these steps.

### Getting Started
### Prerequisites

#### To get a local copy up and running follow these simple example steps.
In order to run this project you need:

```bash
git clone [email protected]:ITurres/ttm-e-commerce.git
### Setup

Clone this repository to your desired folder:

Example commands:

```bash
cd my-folder
git clone [email protected]:ITurres/ttm-e-commerce.git
```

### _⚠️Website will load static-js-data if JSON-server is not loaded.👍_

#### _In order for you to see actual CRUD data and be able to log in as <admin - 123456> follow the steps below._
#### _In order for you to see actual CRUD data and be able to log in as **`admin - 123456`** follow the steps below._

#### Within the project folder

Expand All @@ -86,15 +136,59 @@ json-server -w .\watches-data.json

```

## Author
### Install

Install this project's dependencies with:

- N/A

### Usage

To run the project, execute the following command:

### 🙋‍♂️ Emanuel Iturres
- N/A

- #### [![My Skills](https://skillicons.dev/icons?i=github)](https://skillicons.dev) [@ITurres](https://github.com/ITurres)
- #### [![My Skills](https://skillicons.dev/icons?i=linkedin)](https://skillicons.dev) [Linkedin](https://www.linkedin.com/in/arturoemanuelguerraiturres/details/projects/)
### Run tests

- N/A

<p align="right">(<a href="#readme-top">back to top</a>)</p>

---

<!-- AUTHORS -->

## 👥 Authors <a name="authors"></a>

👤 **Author1**

- GitHub: [@ITurres](https://github.com/ITurres)
- LinkedIn: [Arthur Emanuel G. Iturres](https://www.linkedin.com/in/arturoemanuelguerraiturres/)
- Angellist / Wellfound: [Arturo (Arthur) Emanuel Guerra Iturres](https://wellfound.com/u/arturo-arthur-emanuel-guerra-iturres)
- Youtube: [Arturo Emanuel Guerra Iturres - Youtube Channel](https://www.youtube.com/channel/UC6GFUFHOtBS9mOuI8EJ6q4g)

<p align="right">(<a href="#readme-top">back to top</a>)</p>

---

<!-- CONTRIBUTING -->

## 🤝 Contributing <a name="contributing"></a>

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/ITurres/ttm-e-commerce/issues).

<p align="right">(<a href="#readme-top">back to top</a>)</p>

---

## Show your support
<!-- SUPPORT -->

## ⭐️ Show your support <a name="support"></a>

Give a ⭐ if you liked this project!

#### Give a ⭐ if you liked this project!
<p align="right">(<a href="#readme-top">back to top</a>)</p>

---

0 comments on commit eb0afcd

Please sign in to comment.