About The Project | Technologies | Getting Started | How To Contribute | License
## 👨🏻💻 About the project
GitHub Clone is a project developed in ReactJS in conjunction with TypeScript obeying the concept of Mobile First, where it shows an interface almost identical to the main page of the official GitHub website. This project uses the resources of the GitHub API, therefore, when clicking on a project displayed on the screen, the user will be redirected to a page with some information about the clicked repository and to know more details just click on the button "View on GitHub" and then you will be redirected to the official GitHub page, where more data about the repository in question will be shown.
## 🚀 Technologies Technologies that I used to develop this frontend app - [ReactJS](https://nodejs.org/en) - [TypeScript](https://www.typescriptlang.org) - [Date-FNS](https://date-fns.org/docs/Getting-Started) - [React-Icons](https://react-icons.github.io/react-icons/) - [React-Calendar-Heatmap](https://www.npmjs.com/package/react-calendar-heatmap) - [Styled-Components](https://styled-components.com) - [VS Code](https://code.visualstudio.com) 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/github-clone-reactjs.git $ cd github-clone-reactjs ``` **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/github-clone-reactjs.git $ cd github-clone-reactjs # 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 ## 📝 License This project is under the MIT license. See the [LICENSE](https://github.com/eltonlazzarin/github-clone-reactjs/blob/master/LICENSE) for more information.