Skip to content

KeevenOliveira/search-chuckphrases

Repository files navigation

Chuck Phrases 🔫

chuck-readme

Click here to see deploy in vercel

Table of Contents 📝

  1. How to install
  2. Technologies used
  3. Bests practices
  4. Project Objective
  5. API used
  6. Components

How to install

📌 First all, you has been installed Node.js package in your machine. If you don't have Node.js in you Desktop, see this link here and install the LTS version.

📌 Clone this project;

📌 Install all dependencies.

You may install this project with NPM or Yarn:

With NPM:

npm install

or yarn:

yarn install

📌 Start application

If you use NPM to install all dependencies, use this command in your terminal:

npm start

Or if you use Yarn to install, use this command here:

yarn start

📌 Have a fun!🎉😁

Technologies used

  • TypeScript;
  • React;
  • Styled Components;
  • Axios;
  • React Toastify;
  • React Router;
  • React Icons;
  • React Select;
  • Jest;
  • Testing Library;
  • Cypress;

Bests practices

  • Clean Code;
  • Clean Architecture;
  • SOLID;
  • TDD;

    Unity, Integration and E2E tests

  • DRY;
  • Design Patterns;

Project Objective

I did build this project to practice my knowledge about all technologies above. Furthermore, I use this project to complete challenge for great Nuuvem enterprise.😍

API used

In this project I use the Chuck Norris API.

Components

📌 Card

<Card />
Properties Types
url string
value string

📌 ListCard

<ListCard />
Properties Types
dataSource IChuckData[ ] / [ ]

📌 Search

<Search />
Properties Types
handleSubmit function

Home

<Home />
Properties Types
history BrowserHistory