https://github.com/b2evandro/stimulus-debounce

https://github.com/b2evandro/stimulus-debounce

github rails rails7 rspec-rails stimulus

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/b2evandro/stimulus-debounce
• Owner: b2evandro
• License: mit
• Created: 2023-06-03T05:25:19.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-07T14:15:59.000Z (about 1 year ago)
• Last Synced: 2024-10-17T09:01:05.586Z (22 days ago)
• Topics: github, rails, rails7, rspec-rails, stimulus
• Language: Ruby
• Homepage: https://dark-water-6113.fly.dev/
• Size: 57.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Stimulus Debounce

Stimulus Debounce is a web application built with Ruby on Rails 7, Tailwind CSS, RSpec and StimulusJS. Its main feature is a Github interface to search profiles that utilizes the debounce functionality provided by StimulusJS.

![data](https://github.com/b2evandro/stimulus-debounce/assets/55710708/1ed3040b-4274-4206-87e3-776a6e19e9dc)

![not_found_user](https://github.com/b2evandro/stimulus-debounce/assets/55710708/9c7a4089-e096-408b-9f95-6a235c61f884)

## Installation

To install and run Stimulus Debounce, follow these steps:

1. Clone the repository:

```sh

git clone https://github.com/b2evandro/stimulus-debounce.git

```

2. Install the required gems:

```sh

bundle install

```

3. Start the Rails server:

```sh

rails s

```

Open your web browser and navigate to http://localhost:3000.

## Features

Stimulus Debounce provides the following features:

* Github interface to search profiles

* Debounce functionality provided by StimulusJS

* Responsive design with Tailwind CSS

* Comprehensive test suite using RSpec

## Usage

To use Stimulus Debounce, simply enter a search term into the search bar on the home page and press enter or click the search button. The search results will be displayed below the search bar. As you type, the debounce functionality provided by StimulusJS will delay the search request until a certain amount of time has passed without any additional keystrokes, improving the overall performance of the application.

## Testing

Stimulus Debounce has a comprehensive test suite built with RSpec. To run the tests, simply run the following command:

```sh

rspec

```

## License

Stimulus Debounce is released under the [MIT License](https://opensource.org/licenses/MIT).