Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emmanuelmarcosdeoliveira/contact-list-ofs
Lista de Contatos
https://github.com/emmanuelmarcosdeoliveira/contact-list-ofs
react redux redux-toolkit styled-components typescript
Last synced: about 17 hours ago
JSON representation
Lista de Contatos
- Host: GitHub
- URL: https://github.com/emmanuelmarcosdeoliveira/contact-list-ofs
- Owner: emmanuelmarcosdeoliveira
- Created: 2024-07-15T18:10:36.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-10-31T17:58:23.000Z (3 months ago)
- Last Synced: 2024-11-24T01:30:43.932Z (2 months ago)
- Topics: react, redux, redux-toolkit, styled-components, typescript
- Language: TypeScript
- Homepage: https://contac-list-five.vercel.app/
- Size: 322 KB
- Stars: 1
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# ✨Contact-List
## Table of Contents
- [Project description](#project-description)
- [Functionalities](#functionalities)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [technologies and tools](#technologies-and-tools)
- [Instalation](#instalation)
- [Usage](#usage)
- [Update](#update)
- [References](#references)
- [Contributors or owners](#contributors-or-owners)
- [Contribute-to-the-projects](#contribute-to-the-projects)
- [Contact](#contact)
- [License](#license)
## Project Description
Esse Projeto foi desenvolvido para a pratíca de tecnologias, como `typescript` , `styled-components`, `redux@toolkit`.
Minha fonte de motivação deste projeto foi a [EBAC](https://ebaconline.com.br/).
O **Contac-List** é uma aplicação de gerenciamento de Lista de contatos.
`Task`
- Desenvolver uma aplicação minimalista de um Gerenciador de listas de Contatos usando **@redux/toolkit**
`Charlenge`
Os Maiores desafios foram:
Colocar em pratíca o que foi aprendido no curso, da **EBAC** criando um aplicação simples porem funcional.
### Functionalities
- [x] **Criar um card de contatos**
- [x] **Editar os dados inserridos no Card**
- [x] **Busca po Filtro de Pesquisa, onde o usuário pode pesquisar pelo nome ou pela Categória como: `Famila`, `Pessoal` ou `Trabalho`**
> [!TIP]
>
> Baixe o Projeto em seu Computador e veja como ficou.
## Setup
Requisitos necessários para rodar o projeto:
### Prerequisites
>
`Node.js` `VSCode` `Git`
> [!IMPORTANT]
>
> - Run Time [Node.js](https://nodejs.org/en/) com a versão _16 ou superior_.
> - Um editor de códigos onde eu recomendo o [VCode](https://code.visualstudio.com/)
> - E o [git](https://git-scm.com/downloads) uma aplicação de versionamento de código.
### technologies and tools
`React` `Vite` `styled-components` `redux` `redux@toolkit` `EditorConfig` `ESLint` `Git`
`Prettier` `Pnpm`
## Instalation
Para rodar o projeto em seu computador você tera que fazer o [fork](https://docs.github.com/pt/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) do repositório. Caso você não saiba como fazer, estou deixando um **link** da documentação oficial do gitHub, onde é esclarecido como fazer essse processo.
Fazendo esse processo você tera uma copia desse Repositório no seu GitHub.
Depois de ter feito o **fork** vamos fazer o [clone](https://docs.github.com/pt/repositories/creating-and-managing-repositories/cloning-a-repository) desse Repositório atráves do **VSCode**.
Caso você não saiba como fazer, estou deixando um link para a documentação oficial do gitHub onde é esclarecido como fazer essse processo.
Command Line
```bash
git clone https://github.com/emmanuelmarcosdeoliveira/contac-list
```
Com o **VSCode** aberto, abra o **terminal**. pelo **VsCode** e vamos fazer a instalação das dependências necessárias para a execução do Projeto:
**1. Instalando as dependências**
Gerenciador de pacotes usado
**Pnpm**
Command Line
```bash
pnpm install
```
## Usage
**2. Inicie o Servidor com o seguinte comando dentro do Terminal**
Gerenciador de pacotes usado
**Pnpm**
Command Line
```bash
pnpm run dev
```
> Ira aparecer um Pop-up solicitanto que você clique para acessar o projeto no seu navegador.
> Segure a tecla Control e clique no local específicado, o projeto será aberto em uma nova aba do seu nagevador Preferido.
Imagem de demostração do Projeto
Acesse a versão on-line Projeto clicando no Link Abaixo
## Update
> Nessa seção teremos as atualizações do Projeto:
## References
**Acesse:** [EBAC](https://ebaconline.com.br/)
## Contributors or owners
| owner |
| :---------------------------------------------------------------------------: |
| 
|
| Emmanuel Oliveira |
Creation of styles and project development by 💖 [Emmanuel Oliveira](https://www.linkedin.com/feed/?trk=homepage-basic_sign-in-submit)
© Todos os Direitos Reservados
### Contribute to the projects
Como fazer uma contribuição ao Projeto ?
- Familiarize-se com a documentação do projeto, que geralmente inclui guias de instalação.
- Explore o código do projeto para entender sua estrutura e funcionamento.
**Faça um Fork**
- Crie uma cópia (fork) do repositório original em sua conta do GitHub.
**Clone o Repositório**
Isso criará uma cópia local do projeto, onde você poderá fazer suas modificações.
**Crie uma Nova Branch:**
- Crie uma nova branch para isolar suas alterações.
- Isso facilita a organização do seu trabalho e a criação de pull requests.
**Faça as Alterações:**
- Crie funcionalidades, mude estilos ou resolva `bugs` que iram contribuir para a melhoria do Projeto.
**Crie um Pull Request:**
- Inclua uma descrição clara das suas alterações e explique como elas resolvem o problema ou melhoram o projeto.
- Solicitação: Envie um pull request para o repositório original, solicitando que suas alterações sejam incorporadas ao projeto.
**Revise e Responda a Feedback:**
- Colabore: Os mantenedores do projeto podem solicitar alterações ou fornecer feedback sobre o seu código.
## Contact
😁Obrigado por chegar até aqui!
## License
Released in 2024 This project is under the **MIT license**
[`voltar ao topo`](#contact-list)