https://github.com/vitor-martinss/githubexplorer

This project is based on an application for users that want to explorer repositories on github. This project has been made during the GoStack Bootcamp by Rocketseat.
https://github.com/vitor-martinss/githubexplorer

github githubexplorer gostack-bootcamp javascript nodejs react reactjs rocketseat styledcomponents typescript

Last synced: 25 days ago
JSON representation

This project is based on an application for users that want to explorer repositories on github. This project has been made during the GoStack Bootcamp by Rocketseat.

• Host: GitHub
• URL: https://github.com/vitor-martinss/githubexplorer
• Owner: vitor-martinss
• Created: 2021-02-16T19:00:29.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-02-17T09:23:04.000Z (almost 4 years ago)
• Last Synced: 2024-11-13T12:11:28.095Z (3 months ago)
• Topics: github, githubexplorer, gostack-bootcamp, javascript, nodejs, react, reactjs, rocketseat, styledcomponents, typescript
• Language: TypeScript
• Homepage:
• Size: 748 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


## 💇🏻‍♂️ About the project

This project is based on an application for users that want to explorer repositories on github. For use it, just type your favorite repositorie!

## 💻 Screens





## 🚀 Technologies

Technologies that I used to develop this web client

- [ReactJS](https://reactjs.org/)

- [TypeScript](https://www.typescriptlang.org/)

- [React Router DOM](https://reacttraining.com/react-router/)

- [React Icons](https://react-icons.netlify.com/#/)

- [Styled Components](https://styled-components.com/)

- [Polished](https://github.com/styled-components/polished)

- [Axios](https://github.com/axios/axios)

- [Commitlint](https://github.com/conventional-changelog/commitlint)

- [Commitizen](https://github.com/commitizen/cz-cli)

- [Eslint](https://eslint.org/)

- [Prettier](https://prettier.io/)

- [EditorConfig](https://editorconfig.org/)

## 💻 Getting started

### Requirements

**Clone the project and access the folder**

```bash

$ git clone https://github.com/vitor-martinss/GithubExplorer

$ cd _src/GitHubExplorer.FrontEnd

```

**Follow the steps below**

```bash

# Install the dependencies

$ yarn

# Be sure the file 'src/services/api.ts' have the IP to your API

# Start the client

$ yarn start

```

## 📝 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---

Made with 💜 by Vitor Martins during the GoStack Bootcamp 👋 [See my linkedin](https://www.linkedin.com/in/vitormartinswebdesigner/)