Skip to content

Commit d02d683

Browse files
authored
Update README.md
1 parent b085ccc commit d02d683

File tree

1 file changed

+97
-6
lines changed

1 file changed

+97
-6
lines changed

README.md

Lines changed: 97 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,102 @@
1-
# React + IMask
1+
<table align="right">
2+
<tr>
3+
<td>
4+
<a href="readme-en.md">🇺🇸 English</a>
5+
</td>
6+
</tr>
7+
<tr>
8+
<td>
9+
<a href="README.md">🇧🇷 Português</a>
10+
</td>
11+
</tr>
12+
</table>
213

14+
![luk4x-repo-status](https://img.shields.io/badge/Status-Finished-lightgrey?style=for-the-badge&logo=headspace&logoColor=green&color=lightgrey)
15+
![luk4x-repo-license](https://img.shields.io/github/license/Luk4x/react-imask?style=for-the-badge&logo=unlicense&logoColor=lightgrey)
16+
# IMask in React
17+
18+
<br>
19+
<p align="center">
20+
<a href="#-apresentação-em-gif-do-projeto">Gif</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
21+
<a href="#-tecnologias-utilizadas">Tecnologias</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
22+
<a href="#-sobre">Sobre</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
23+
<a href="#-clonando-o-projeto">Clone</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
24+
<a href="#-contato-dos-contribuintes">Contato</a>
25+
</p>
26+
<br>
27+
28+
## 📹 Apresentação em Gif do Projeto
329
<div align="center">
430
<img src="https://user-images.githubusercontent.com/86276393/206425046-6cf7122d-f5e4-40fd-82f3-df27fea62cfc.gif" />
531
</div>
632

7-
Originating from GenCard, this was a simple project developed with the aim of showing how to use IMask in React with regex to a friend who needed help with his work.<br>
8-
The MasterCard regex was used as an example - If the number entered in the input is from MasterCard, the border of the input turns green, otherwise it turns red.<br>
9-
MasterCard numbers example: `5349 0234 9207 3492`, `2329 7329 4792 3759`.
10-
<br><br>
11-
Access project [HERE](https://luk4x-react-imask.netlify.app/)
33+
> Acesse o projeto online **[AQUI](https://luk4x-react-imask.netlify.app/)**
34+
35+
## 🚀 Tecnologias Utilizadas
36+
37+
- [ReactJS](https://pt-br.reactjs.org)
38+
- [iMask](https://imask.js.org)
39+
- [Styled-Components](https://styled-components.com)
40+
- [Regex](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions)
41+
- [ViteJS](https://vitejs.dev/)
42+
- [NodeJS](https://nodejs.org)
43+
- [npm](https://www.npmjs.com/)
44+
- [Javascript](https://developer.mozilla.org/en-US/docs/Web/JavaScript)
45+
- [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS)
46+
- [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML)
47+
48+
## 📝 Sobre
49+
50+
Originado do meu projeto [GenCard](https://github.com/Luk4x/gencard), este foi um projeto simples desenvolvido com o objetivo de mostrar como usar IMask em React com regex para um amigo que precisava de ajuda com seu trabalho.<br>
51+
O regex da MasterCard foi usado como exemplo: Se o número digitado no input for da MasterCard, a borda do input fica verde, caso contrário, fica vermelha.<br>
52+
Exemplo de números da MasterCard: `5349 0234 9207 3492`, `2329 7329 4792 3759`.
53+
54+
## 📖 Clonando o Projeto
55+
56+
Para clonar e executar este projeto em seu computador, você precisará do [Git](https://git-scm.com/) e [Node.js v18.12.1](https://nodejs.org/en/) ou superior previamente instalados.<br>
57+
Feito isso, no terminal:
58+
59+
```bash
60+
# Clone esse repositório com:
61+
> git clone https://github.com/Luk4x/react-imask.git
62+
63+
# Entre no repositório com:
64+
> cd react-imask
65+
66+
# Instale as dependências com:
67+
> npm install
68+
69+
# Execute o projeto com:
70+
> npm run dev
71+
72+
# Feito isso, você já poderá acessar o projeto pelo link que aparecerá no terminal! (algo como http://localhost:3000/ ou http://127.0.0.1:5173/)
73+
```
74+
75+
## 🤝 Contato dos Contribuintes
76+
77+
<table border="2">
78+
<tr>
79+
<td align="center">
80+
<b><a href="https://cursos.alura.com.br/vitrinedev/lucasmacielf">Vitrine.Dev</a> 🪟</b>
81+
<table>
82+
<tr>
83+
<td align="center">
84+
<a href="https://github.com/Luk4x">
85+
<img src="https://avatars.githubusercontent.com/Luk4x" width="150px;" alt="Luk4x Github Photo"/>
86+
</a>
87+
<br>
88+
<a href="https://www.linkedin.com/in/lucasmacielf/">
89+
<sub>
90+
<b>Lucas Maciel</b>
91+
</sub>
92+
</a>
93+
</td>
94+
</tr>
95+
</table>
96+
</td>
97+
</tr>
98+
</table>
99+
100+
<p align="right">
101+
<a href="#imask-in-react">Voltar ao Topo</a>
102+
</p>

0 commit comments

Comments
 (0)