/vicove-preserve

Bulgarian jokes - A easy to use API endpoint providing access to more then 100k jokes in different categories

Primary LanguagePHP

Bulgarian Jokes

A easy to use API endpoint providing access to more then 100k jokes in different categories

Untitled-1(1)

Demo

Tiradzhii jokes

Docs for the API

API Docs

API Reference

Base url

https://1cdek6bg7g.execute-api.eu-central-1.amazonaws.com

Get all jokes (10 per page)

  GET /
Parameter Type Description
cursor string? Optional. Cursor hash for next paginated page

Get all categories

  GET /categories

Get all jokes for category (10 per page)

  GET /category{category}
Parameter Type Description
category string Required. title_bg category name from /categories - Example: Китай

Tech Stack Requirements

  • PHP 8.0+
  • Composer
  • NPM
  • Serverless framework (for deploy)
  • AWC CLI with default profile set

Installation

Clone the project

  git clone https://github.com/PixellUp/vicove-preserve

Go to the project directory

  cd vicove-preserve

Install dependencies

  composer install
  npm install
  cp .env.example .env

Deployment

To deploy this project run

  serverless deploy

Acknowledgements

This won't be possible without help from