https://github.com/gentildpinto/gitfinder

A simple tool that allows find GitHub users by his username.
https://github.com/gentildpinto/gitfinder

github rails ruby ruby-on-rails tailwindcss

Last synced: about 2 months ago
JSON representation

A simple tool that allows find GitHub users by his username.

• Host: GitHub
• URL: https://github.com/gentildpinto/gitfinder
• Owner: gentildpinto
• License: mit
• Archived: true
• Created: 2021-01-17T00:01:22.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-15T06:55:23.000Z (7 months ago)
• Last Synced: 2024-05-19T01:40:02.134Z (4 months ago)
• Topics: github, rails, ruby, ruby-on-rails, tailwindcss
• Language: JavaScript
• Homepage:
• Size: 1.56 MB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-made-by-angolans - gitfinder

README

        


  
GitHub Profile Finder


  
A tool that allows anyone to find GitHub users by his username.


  Table of Contents

  


    


      About The Project

      


        
Built With

      

    

    


      Getting Started

      


        
Prerequisites

        
Installation

      

    

    
Contributing

    
License

    
Contact

  


## About The Project

![Profile Finder](screenshots/gh.gif)

A simple tool that allows anyone to find GitHub users by his username.

### Built With

This project was built with:

* [Ruby on Rails](https://rubyonrails.org/)

* [Tailwind CSS](https://tailwindcss.com/)

* [sweetalert2](https://sweetalert2.github.io/)

Extra:

* [Profile Card Template](https://www.tailwindtoolbox.com/templates/profile-card)

## Getting Started

This is an example of how you may give instructions on setting up your project locally.

To get a local copy up and running follow these simple example steps.

### Prerequisites

This is a list of the things you need to use the software.

* [Ruby](http://www.ruby-lang.org/en/)

* [Rails cli](https://rubyonrails.org/)

* [nodejs](https://nodejs.org/en/)

* [yarn](https://yarnpkg.com/)

### Installation

1. Clone the repo

   ```sh

   git clone https://github.com/gentildpinto/gitfinder.git

   ```

2. Install gems with bundler

   ```sh

   bundle install

   ```

3. Install JavaScript packages with yarn

   ```sh

   yarn install

   ```

4. Run the project

   ```sh

   rails s

   ```

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project

2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)

3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)

4. Push to the Branch (`git push origin feature/AmazingFeature`)

5. Open a Pull Request

## License

Distributed under the MIT License. See `LICENSE` for more information.

## Contact

Gentil Pinto - [@gentil__pinto](https://twitter.com/gentil__pinto) - [email protected] - [Linkedin](https://www.linkedin.com/in/gentilpinto)