README.md

Simple Frontend build in ReactJS and TypeScript

About The Project   |    Technologies   |    Getting Started   |    How To Contribute   |    License

👨🏻‍💻 About the project

🚀 Technologies

Technologies that I used to develop this frontend app

• ReactJS
• TypeScript
• React-Icons
• React-Router-Dom
• Axios
• Styled-Components
• Polished
• React-Icons
• VS Code, ESLint with EditorConfig and Prettier RC

💻 Getting started

Requirements

• Node.js
• Yarn or npm

Clone the project and access the folder

$ git clone https://github.com/eltonlazzarin/frontend-challenge.git

$ cd frontend-challenge

Follow the steps below

# Install the dependencies
$ yarn

# Run the web app
$ yarn start

🤔 How to contribute

Follow the steps below

# Clone your fork
$ git clone https://github.com/eltonlazzarin/frontend-challenge.git

$ cd frontend-challenge

# Create a branch with your feature
$ git checkout -b your-feature

# Make the commit with your changes
$ git commit -m 'feat: Your new feature'

# Send the code to your remote branch
$ git push origin your-feature

After your pull request is merged, you can delete your branch

Frontent Simple UI Tests

$ git clone https://github.com/eltonlazzarin/frontend-challenge.git

$ cd frontend-challenge

$ yarn test

📝 License

This project is under the MIT license. See the LICENSE for more information.