gagigante/Github-Explorer

A simple repository explorer client built with React

Github Explorer

Technologies   |    How to run   |    Project   |    How to contribute   |    License

🚀 Technologies

This project was developed with the following techs:

• React
• TypeScript
• React Router Dom
• Styled Components
• Eslint
• Prettier

💻 Project

This project is a simple and fashion way to explore Github repositories. \o/

🏃 How to run

Client:

Just access the project fold:

To install dependencies

  $ yarn

  or

  $ npm install

To start the server

  $ yarn start

  or

  $ npm start

🤔 How to contribute

• Fork this repo;
• Create a branch for your new feature: git checkout -b my-feature;
• Commit your changes: git commit -m 'feat: My brand new feature';
• Push it to your branch: git push origin my-feature.

After merge of your pull request, you can delete your branch.

📝 License

This project is under MIT license. See the file LICENSE for details.

---