# README
Subscribed
Subscribed is a webhook provider that allows software developers to quickly add webhook capabilities into their applications, without having to deal with common webhook-related challenges such as:
- Unavailable webhook endpoint
- Network issues
- Retries
- Schema validation
In early-stage development of a Webhooks provider platform... things will change, a lot.
Getting started
Requirements
- Docker and Docker Compose
- Taskfile: An alternative to Make used to run custom tasks defined in ./Taskfile.yml
Setup
- Clone the repository
git clone [email protected]:subscribeddotdev/subscribed-backend.git - Build the container with all the CLI tools that this repo depends on:
task setup - Run the project:
task run - View logs:
task logs
Running tests:
- Running unit and integration tests
task test - Running component tests
task test:component - Running all tests
task test:all
Other operations:
- Running migrations upwards
task mig:up - Running migrations downwards
task mig:down - Generating handlers from the Open API spec
task openapi - Generating ORM models
task orm - Generating models from the event specification
task events