Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rubydevi/webhook-notifier
The "WebhookNotifier" is a Ruby on Rails application designed to facilitate real-time communication between the application and third-party APIs.
https://github.com/rubydevi/webhook-notifier
rspec ruby-on-rails
Last synced: 8 days ago
JSON representation
The "WebhookNotifier" is a Ruby on Rails application designed to facilitate real-time communication between the application and third-party APIs.
- Host: GitHub
- URL: https://github.com/rubydevi/webhook-notifier
- Owner: rubydevi
- License: mit
- Created: 2024-03-28T11:44:39.000Z (7 months ago)
- Default Branch: dev
- Last Pushed: 2024-03-30T14:35:32.000Z (7 months ago)
- Last Synced: 2024-10-09T10:44:55.095Z (30 days ago)
- Topics: rspec, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 54.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Setup .ENV](#setup-env)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
The "WebhookNotifier" is a simple Ruby on Rails application crafted to enable seamless communication between your application and external third-party APIs of your choice. Users can effortlessly store and update data via RESTful endpoints. Simultaneously, it notifies designated third-party APIs of any pertinent changes through webhook deliveries, ensuring that all involved parties remain up-to-date in real-time.
- Secure Webhook Delivery
- Configurable Webhook Endpoints
- Reliable Data Delivery
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Ruby installed on your machine
- Rails installed on your machine
- PostgreSQL installed on your machine
Make sure you have these prerequisites fulfilled before proceeding with the project.
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone https://github.com/rubydevi/webhook-notifier.git
```
### Install
Install this project with:
```sh
bundle install
```
### setup-env
1. create an env file by running the following command
```sh
touch .env
```
Or create the .env file manually at the root of the application.
2. open databse.yml file and Find the default: &default section in the file and copy the credentials into your .env file:
```sh
DB_USERNAME=your_username
DB_PASSWORD=your_password
```
### Usage
To run the project, you will need to execute:
```sh
rails db:create
rails db:migrate
rails s
```
### Run tests
To run tests, run the following command:
```sh
rails db:migrate RAILS_ENV=test
rspec spec/models/
rspec spec/requests/
```
👤 Chongtham Ruby Devi
- GitHub: [@rubydevi](https://github.com/rubydevi)
- LinkedIn: [@Chongtham Ruby Devi](https://www.linkedin.com/in/chongtham-bhoomika/)
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/rubydevi/webhook-notifier/issues).
Thank you for taking the time to explore this project! Your support means a lot to me. If you find my project valuable and would like to contribute, here is one way you can support me:
- Star the project ⭐️: Show your appreciation by starring this GitHub repository. It helps increase visibility and lets others know that the project is well-received.
- Fork the project 🍴 🎣: If you're interested in making improvements or adding new features, feel free to fork the project. You can work on your own version and even submit pull requests to suggest changes.
- Share with others 🗺️: Spread the word about this project. Share it on social media, mention it in relevant forums or communities, or recommend it to colleagues and friends who might find it useful.
[](./LICENSE)