An open API service indexing awesome lists of open source software.

https://github.com/leomssilva/upmedal-vtex

:technologist: VTEX IO challenge project in Hiring Coders #2
https://github.com/leomssilva/upmedal-vtex

Last synced: 3 months ago
JSON representation

:technologist: VTEX IO challenge project in Hiring Coders #2

Awesome Lists containing this project

README

        

Desafio UPMedal VTEX

[![Author](https://img.shields.io/badge/author-LeoMSSilva-blue?style=flat-square)](https://github.com/LeoMSSilva)
[![Version](https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000)](https://github.com/LeoMSSilva)
[![Languages](https://img.shields.io/github/languages/count/LeoMSSilva/UPMedal-VTEX?color=blue&style=flat-square)](#)
[![Stars](https://img.shields.io/github/stars/LeoMSSilva/UPMedal-VTEX?color=blue&style=flat-square)](https://github.com/LeoMSSilva/UPMedal-VTEX/stargazers)
[![Forks](https://img.shields.io/github/forks/LeoMSSilva/UPMedal-VTEX?color=blue&style=flat-square)](https://github.com/LeoMSSilva/UPMedal-VTEX/network/members)
[![Contributors](https://img.shields.io/github/contributors/LeoMSSilva/UPMedal-VTEX?color=blue&style=flat-square)](https://github.com/LeoMSSilva/UPMedal-VTEX/graphs/contributors)

---

# :pushpin: Table of Contents

- :house: [About](#house-about)
- :dart: [Installation](#dart-installation)
- :gear: [Install dependencies](#hammer_and_wrench-install-dependencies)
- :rocket: [Getting started](#rocket-getting-started)
- :computer: [Techs](#computer-techs)
- :bust_in_silhouette: [Author](#bust_in_silhouette-author)
- :handshake: [Contributing](#handshake-contributing)

---

# :house: About

This project is about Hiring Coders VTEX IO + AWS challenge. It was based on the [Minimum Boilerplate Theme](https://github.com/vtex-apps/minimum-boilerplate-theme.git) and an attempt to clone the [UPMedal](https://www.upmedal.com) website interface.

---

# :dart: Installation

**First you need to install:**

- [Node.js](https://pt-br.nodejs.org/) (required)
- [Yarn](https://yarnpkg.com/) (required)

**Then in order, clone the project.**

By HTTPS, running this command:

```bash
git clone https://github.com/LeoMSSilva/UPMedal-VTEX.git
```

Or by ssh, running this command:

```bash
git clone [email protected]:LeoMSSilva/UPMedal-VTEX.git
```

SSH is a secure protocol, but you need to register a key ssh in your github before.

## :hammer_and_wrench: Install dependencies

```bash
yarn
```

or

```bash
yarn install
```

### Next

```bash
yarn global add vtex
```

## :rocket: Getting Started

```bash
vtex browse
```

---

# :computer: Techs

- Typescript
- VTEX IO

---

# :bust_in_silhouette: Author

**LeoMSSilva**

- Github: [@LeoMSSilva](https://github.com/LeoMSSilva)
- LinkedIn: [@LeoMSSilva](https://linkedin.com/in/LeoMSSilva)

---

# :handshake: Contributing

Contributions, issues and feature requests are welcome! Feel free to **file a new issue** on the [UPMedal-VTEX](https://github.com/LeoMSSilva/UPMedal-VTEX/issues) repository. If you already found a solution to your problem, **I would love to review your pull request**!

---