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

https://github.com/eltonlazzarin/frontend-challenge

Simple Frontend build in ReactJS and TypeScript
https://github.com/eltonlazzarin/frontend-challenge

axios github github-repository-search githubapi javascript javascriptapps jest-tests polished react-app react-icons reactjs styled-components tdd-typescript typescript unity-test

Last synced: about 2 months ago
JSON representation

Simple Frontend build in ReactJS and TypeScript

Awesome Lists containing this project

README

          


Simple Frontend build in ReactJS and TypeScript


GitHub top language

GitHub language count

GitHub last commit

GitHub issues

GitHub


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

## 👨🏻‍💻 About the project


Project Screenshots

## 🚀 Technologies

Technologies that I used to develop this frontend app

- [ReactJS](https://nodejs.org/en)
- [TypeScript](https://www.typescriptlang.org)
- [React-Icons](https://github.com/wwayne/react-tooltip)
- [React-Router-Dom](https://reactrouter.com/web/guides/quick-start)
- [Axios](https://github.com/axios/axios)
- [Styled-Components](https://styled-components.com)
- [Polished](https://github.com/styled-components/polished)
- [React-Icons](https://react-icons.github.io/react-icons)
- [VS Code](https://code.visualstudio.com), [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) with [EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) and [Prettier RC](https://github.com/prettier/prettier)

## 💻 Getting started

### Requirements

- [Node.js](https://nodejs.org/en/)
- [Yarn](https://classic.yarnpkg.com/) or [npm](https://www.npmjs.com/)

**Clone the project and access the folder**

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

$ cd frontend-challenge
```

**Follow the steps below**

```bash
# Install the dependencies
$ yarn

# Run the web app
$ yarn start
```

## 🤔 How to contribute

**Follow the steps below**

```bash
# 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

```bash
$ 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](https://github.com/eltonlazzarin/frontend-challenge/blob/master/LICENSE) for more information.